...
- Project: A named configuration that relates an administrative user, likely represented by a client certificate, to a set of resource allocations (quotas), and resources (namespace, pods/services, volumes, configurations).
- Stack: A set of services that are administratively related (i.e., started and stopped together). For example, "clowder" or "dataverse"
- Service definition: A specification of a logical "service" that includes a name, description, storage requirements, configuration options, and relationships to other services. An NDSLabs "service" may be composed of multiple related containers.
- Service library: A collection of service definitions and procedures for adding official/trusted as well as local/development services.
- Service instance: An instance of a service configured and running in a project namespace.
- Resource quota: A set of soft and hard limits assigned to a project (storage and compute).
- Volume: A named, allocated storage resource that counts against the project quota and can be mounted by one or more services.
...
| Path | Action | Project Admin | Cluster Admin | Notes |
|---|---|---|---|---|
| / | List available paths | GET | GET | |
| /authenticate | PUT | PUT | returns token | |
| /services | List, add site-wide and project-specific services | GET, PUT | PUT | |
| /services/{service-id} | Get, update, delete site-wide services | GET | PUT, DELETE | |
| /services/templates/{service-id}/{service|controller} | Put, get, delete service templates | GET | PUT, DELETE | |
| /projects | List, add projects | GET, PUT | ||
| /projects/{project-id} | Get, update, delete project | GET, PUT | DELETE | |
| /projects/{project-id}/serviceInstances | List, add project services | GET, PUT | ||
| /projects/{project-id}/serviceInstances/{instance-id} | Get, update, delete project service | GET, PUT, DELETE | ||
| /projects/{project-id}/serviceInstances/{instance-id}/status | Get, update, delete project services status | GET, PUT, DELETE | start, stop, restart | |
| /projects/{project-id}/serviceInstance/{instance-id}/config | Get, update, delete service configurations | GET, PUT, DELETE | ||
| /projects/{project-id}/volumes | List, add project volumes | GET, PUT | ||
| /projects/{project-id}/volumes/{volume-id} | Get, update, delete project volumes | GET, PUT, DELETE | ||
| /projects/{project-id}/{stack-id} | Get, update, delete service stack | GET, PUT, DELETE | ||
| /projects/{project-id}/{stack-id}/actions/{action} | Start/Stop a stack | GET,PUT | ||
| /projects/{project-id}/{stack-id}/services/{service-id} | Get, update, delete services in a stack | GET, PUT, DELETE |
A first draft of the spec is available via git on the NDS-108 branch
...
This can be opened using the Swagger editor demo http://editor.swagger.io/, if desired.
Authentication
We will likely use a JSON Web-Token approach (JWT)
The interceptor model described here https://thinkster.io/angularjs-jwt-auth also looks like a handy way to keep things alive without persisting stuff on the client.
- Password will be validated against the server-side "project" structure
Volumes
- If development environment, creating a volume is just a mkdir on some local path
- If production environment, creating a volume requires a call to the Openstack API (Create, Attach) then a local call to mkfs, then a call to the Openstack API (Detach)
API Server (prototype)
The prototype NDSLabs API Server will be used by the CLI and GUI applications.
...