V2 API Specification
- Kiran
- Former user (Deleted)
- Eric Multanen
- 1 Projects API
- 1.1 POST
- 1.1.1 POST
- 1.2 GET, DELETE
- 1.2.1 GET, DELETE
- 1.2.2 GET, DELETE
- 1.1 POST
- 2 Composite Application API
- 2.1.1 POST
- 2.1.1.1 POST
- 2.1.2 GET, DELETE
- 2.1.2.1 GET, DELETE
- 2.1.1 POST
- 2.2 Adding applications to composite app
- 2.2.1 POST
- 2.2.1.1 POST
- 2.2.2 GET, DELETE
- 2.2.2.1 GET, DELETE
- 2.2.1 POST
- 3 Profile API
- 3.1.1 POST
- 3.1.1.1 POST
- 3.1.2 GET, DELETE
- 3.1.2.1 GET, DELETE
- 3.1.1 POST
- 3.2 Adding profile per application
- 3.2.1 POST
- 3.2.1.1 POST
- 3.2.2 GET, DELETE
- 3.2.2.1 GET, DELETE
- 3.2.1 POST
- 4 Generic Placement Intent API
- 4.1.1 POST
- 4.1.1.1 POST
- 4.1.2 GET, DELETE
- 4.1.2.1 Get, Delete
- 4.1.1 POST
- 4.2 Adding placement intent for each application in the composite-app
- 4.2.1 POST
- 4.2.1.1 POST
- 4.2.2 GET, DELETE
- 4.2.2.1 Get, Delete
- 4.2.1 POST
- 5 Deployment Intent Group API
- 5.1.1 POST
- 5.1.1.1 POST
- 5.1.2 GET, DELETE
- 5.1.2.1 Get, Delete
- 5.1.1 POST
- 5.2 Adding intents to an Intent group
- 5.2.1 POST
- 5.2.1.1 POST
- 5.2.2 GET, DELETE
- 5.2.2.1 Get, Delete
- 5.2.1 POST
- 6 Instantiation, Destroy, Status API
- 7 Cluster Registration API
- 7.1.1 POST
- 7.1.1.1 POST
- 7.1.1.2 Get, Delete
- 7.1.2 POST
- 7.1.2.1 POST
- 7.1.2.2 Get, Delete
- 7.1.1 POST
- 7.2 Add Label to a cluster
- 7.2.1 POST
- 7.2.1.1 POST
- 7.2.2 GET, DELETE
- 7.2.2.1 Get, Delete
- 7.2.1 POST
- 7.3 Add key-value pair to a cluster
- 7.3.1 POST
- 7.3.1.1 POST
- 7.3.2 GET, DELETE
- 7.3.2.1 Get, Delete
- 7.3.1 POST
- 8 Orchestrator Controller Registration API
- 8.1 POST
- 8.1.1 POST
- 8.2 GET, DELETE
- 8.2.1 GET, DELETE
- 8.2.2 POST
- 8.1 POST
Projects API
The project allows multi-tenancy in the application from a user perspective.
POST
POST
POST
URL: /v2/projects
POST BODY:
{
"metadata": {
"name": "<name>",
"description": "<description>",
"userData1": "<user data>",
"userData2": "<user data>"
}
}
RETURN STATUS: 201
RETURN BODY:
{
"metadata": {
"name": ""<name>",
"description": "<description>",
"userData1": "<user data>",
"userData2": "<user data>"
}
}GET, DELETE
GET, DELETE
GET
URL: /v2/projects/{project-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata": {
"name": "<name>",
"description": "<description>",
"userData1": "<user data>",
"userData2": "<user data>"
}
}
DELETE
URL: /v2/projects/{project-name}
RETURN STATUS: 204
GET, DELETE
GET
URL: /v2/projects/{project-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata": {
"name": "<name>",
"description": "<description>",
"userData1": "<user data>",
"userData2": "<user data>"
}
}
DELETE
URL: /v2/projects/{project-name}
RETURN STATUS: 204
Composite Application API
Composite Application names are unique within a Project. Composite application resource represents a collection of applications and each application is represented by helm charts. Each Helm chart is wrapped in tar.gz format.
POST
POST
GET, DELETE
GET, DELETE
Adding applications to composite app
Format of the Helm chart for the application wrapped in tar.gz
|
POST
This POST is a multipart POST. With the POST body containing the data about the application and the tar.gz uploaded in multipart form.
POST
GET, DELETE
GET, DELETE
Profile API
Once the definitions for applications are created, profiles are created to customize the applications. Later on, they are instantiated in Kubernetes by the instantiation API.
POST
POST
GET, DELETE
GET, DELETE
Adding profile per application
A per application profile contains the following:
manifest.yaml
Contains the details for the profile and everything contained within
A HELM values override yaml file.
It can have any name as long as it matches the corresponding entry in the manifest.yaml
Any number of files organized in a folder structure
All these files should have a corresponding entry in manifest.yaml file
Sample Profile is described below:
Create the profile artifact
Creating a Profile Artifact
1 |
|
The manifest file contains the following:
manifest.yaml
1 |
|
POST
This POST is a multipart POST. With the POST body containing the data about the profile and the profile tar.gz uploaded in multipart form.
POST
GET, DELETE
GET, DELETE
Generic Placement Intent API
Generic Placement Intent API is used to create generic placement intents for sub-applications in an application. Intent created using this API will be added to an Intent Group for use during instantiation.
POST
POST
GET, DELETE
Get, Delete
Adding placement intent for each application in the composite-app
POST
POST
GET, DELETE
Get, Delete
Deployment Intent Group API
Deployment Intent Group API is used to create Intent Groups that can then will be used at instantiation time. Some intents that can be part of an Intent Group are Generic Placement Intent, HPA Intent, and traffic controller Intent.
POST
POST
GET, DELETE
Get, Delete
Adding intents to an Intent group
POST
POST
GET, DELETE
Get, Delete
Instantiation, Destroy, Status API
Instantiation API to instantiate composite app based on intent-group. Destroy API deletes the app and Status API returns the resources
POST
POST
Cluster Registration API
API to support Reachability for a Kubernetes Cloud. This API will be used to upload configuration information for the cluster
POST
POST
GET, DELETE
Get, Delete
POST
This POST is a multipart POST. With the POST body containing the data about the cluster and the kubeconfig uploaded in multipart form.
POST
GET, DELETE
Get, Delete
Add Label to a cluster
POST
POST
GET, DELETE
Get, Delete
Add key-value pair to a cluster
Add property to a cluster without the need for change to the API.
POST
POST
GET, DELETE
Get, Delete
Orchestrator Controller Registration API
This API allows controllers to register themselves as gRPC servers consumed by the orchestrator.
POST
POST
GET, DELETE
GET, DELETE
Example CURL Command: