vmware
Gather API endpoint requirements
User Statement As a UI developer I want to figure out what API endpoint are required for the VIC Appliance management UI.
Acceptance Criteria Identify Angular services For each Angular service, identify endpoints Communicate the requirements with @andrewtchin so they are reflected in a Swagger model
Angular Services
- AuthService: handles authentication through Appliance Admin API
- ApplianceService: handles VIC appliance lifecycle operations (health check, register w/ PSC, etc.)
- UpgradeService: handles upgrading VIC
API endpoints required
Authentication
- login: handles authentication through Appliance Admin API
- isLoggedIn: checks if the access token is valid
Appliance
- registerWithPSC
- reregisterWithPSC (if applicable)
- isRegisteredWithPSC
- getVCThumbprint
Upgrade
- getUpgradableVersions
- getCurrentVersion
- getComputeResources
- upgrade
We also need some for getting/setting the password, network settings, etc. currently in the vApp settings
Do we want to have an individual API endpoint for each of the sections here? https://vmware.invisionapp.com/share/XMFA0LGKZ#/screens/268527690
I would not mind going with a single endpoint or multiple.
I don't have a preference. I suppose in either case we would require coordination if updating or adding keys/new fields. Also we need an API to get the log bundle. This will return the download .tgz of the logs
Also there should be an API to poll to display the please wait page until the login page is ready to do appliance initialization
@andrewtchin Adding a couple more endpoints:
- get target VC address so we can display in the UI which VC the user is about to register the appliance with
- get the URL to the vic engine tarball
- get the URL to admiral (or could it be just ${hostname}:8282?)
regarding your last comment, yes we do need one. thanks for catching that.
maybe there should also be an install UI plugin API? and uninstall/reinstall?