...
Code Block |
---|
language | bash |
---|
title | GET, DELETE |
---|
linenumbers | true |
---|
|
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.
...
Code Block |
---|
language | jsbash |
---|
title | POSTGET, DELETE |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps
POST
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps
POST BODY: "spec":{
"version":"<version of the composite app>"
}
}
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"version":"<version of the composite app>"
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | GET, DELETE |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}
RETURN
RETURN STATUS: 200201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"version":"<version of the composite app>"
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | GET, DELETE |
---|
linenumbers | true |
---|
|
GET
DELETE
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}
RETURN STATUS: 200
RETURN BODY: 204 |
Adding applications to composite app
Format of the Helm chart for the application wrapped in tar.gz
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"version":"<version of the composite app>"
}
}
DELETE
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}
RETURN STATUS: 204 |
Adding applications to composite app
Format of the Helm chart for the application wrapped in tar.gz
> cd vagrant /tests/vnfs/test/helm
> find vault-consul-dev
vault-consul-dev
vault-consul-dev /Chart > cd vagrant /tests/vnfs/test/helm
> find vault-consul-dev
vault-consul-dev
vault-consul-dev /Chart .yaml
vault-consul-dev /values .yaml
vault-consul-dev /templates
vault-consul-dev /templates/service .yaml
vault-consul-dev /templates/deployment .yaml
vault-consul-dev /charts
vault-consul-dev /charts/common/values .yaml
vault-consul-dev /charts/common/templates/_service .tpl values .yaml
vault-consul-dev /charts/common/templates/_repository .tpl
vault-consul-dev /charts/common/templates/_nameservice .tplyaml
vault-consul-dev /charts/common/templates/_namespacedeployment .tplyaml
vault-consul-dev /charts/common/templates
vault-consul-dev /charts/common/Chartvalues .yaml
vault-consul-dev /charts/common
/templates/_service .tpl
vault-consul-dev /charts/common/templates/_repository .tpl
vault-consul-dev /charts/common/templates/_name .tpl
vault-consul-dev /charts/common/templates/_namespace .tpl
vault-consul-dev /charts/common/templates
vault-consul-dev /charts/common/Chart .yaml
vault-consul-dev /charts/common
> tar -cf vault-consul-dev. tar vault-consul-dev
> vault-consul-dev
> gzip vault-consul-dev. tar
|
POST
...
gzip vault-consul-dev. tar
|
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.
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/apps
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
Code Block |
---|
language | js |
---|
title | GET, DELETE |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/apps/{app-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
Multipart response containing the tar.gz of the Helm chart for the app
DELETE
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/apps/{app-name}
RETURN STATUS: 204 |
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{verison}/composite-profiles
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
Code Block |
---|
language | js |
---|
title | GET, DELETE |
---|
linenumbers | true |
---|
|
GET
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/composite-profiles/{composite-profile-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
DELETE
URL: /v2/projects/{project-name}/composite-apps/{app-name}/{app-version}/composite-profiles/{composite-profile-name}
RETURN STATUS: 204 |
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 2 3 4 5 6 7 8 9 10 11 12 13 | > cd vagrant /tests/vnfs/test/helm/profile
> find .
manifest.yaml
override_values.yaml
testfol
testfol /subdir
testfol /subdir/deployment .yaml
> cd profile
> tar -cf profile. tar *
> gzip profile. tar
> mv profile. tar .gz ../
|
The manifest file contains the following:
manifest.yaml
1 2 3 4 5 6 7 | ---
version: v1
type:
values: "values_override.yaml"
configresource:
- filepath : testfol/subdir/deployment.yaml
chartpath: vault-consul-dev/templates/deployment.yaml
|
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.
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{verison}/composite-profiles/{composite-profile-name}/profiles
POST BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"app-name": "<name>", // Must match the name given in composite-apps/apps API
}
}
Multipart request containg tar.gz of the profile
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"app-name": "<name>", // Must match the name given in composite-apps/apps API
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | POSTGET, DELETE |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projectsproject/{project-name-name}/composite-apps/{composite-app-name}/{version}/composite-appsprofiles/{composite-appprofile-name}/profiles/{version}/apps
POSTprofile-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"app-name": "<name>", // Must match the name given in composite-apps/apps API
"userData1":"<user data>",
"userData2":"<user data>"
}
} }
}
Multipart response containing the tar.gz of the profile
GET (Query)
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/composite-profiles/{composite-profile-name}/profiles?app-name=<app-name>
RETURN STATUS: 201200
RETURN BODY:
{
"metadata":{
"name":"<name>",
{
"descriptionapp-name": "<description><name>",
}
Multipart response containing the tar.gz of "userData1":"<user data>",
"userData2":"<user data>"
}
} |
...
the profile
DELETE
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/composite-profiles/{composite-profile-name}/profiles/{profile-name}
RETURN STATUS: 204 |
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
Code Block |
---|
language | js |
---|
title | GET, DELETEPOST |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/apps/{app-name}
RETURN STATUS: 200
RETURNgeneric-placement-intents
POST BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
Multipart response containing the tar.gz of the Helm chart for the app
DELETE
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/apps/{app-name}
RETURN STATUS: 204 |
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{verison}/composite-profiles
POST BODY:,
"spec":{
"logical-cloud": "logical-cloud-name" //name of logical cloud to use for instantiation. The DCM API will provide the list of clusters that are part of the logical-cloud
}
}
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
RETURN STATUS: 201
RETURN BODY:
{,
"metadataspec":{
"namelogical-cloud": "<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"logical-cloud-name" //name of logical cloud to use for instantiation. The DCM API will provide the list of clusters that are part of the logical-cloud
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | GETGet, DELETEDelete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projectprojects/{project-name}/composite-apps/{composite-app-name}/{version}/compositegeneric-placement-profilesintents/{composite-profileintent-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
DELETE
URL: /v2/projects/{project-name}/composite-apps/{app-name}/{app-version}/composite-profiles/{composite-profile-name}
RETURN STATUS: 204 |
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
2
3
4
5
6
7
8
9
10
11
12
13
...
>
cd
vagrant
/tests/vnfs/test/helm/profile
>
find
.
manifest.yaml
override_values.yaml
testfol
testfol
/subdir
testfol
/subdir/deployment
.yaml
>
cd
profile
>
tar
-cf profile.
tar
*
>
gzip
profile.
tar
>
mv
profile.
tar
.gz ../
},
"spec":{
"logical-cloud": "logical-cloud-name" //name of logical cloud to use for instantiation. The DCM API will provide the list of clusters that are part of the logical-cloud
}
}
DELETE
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intents/{intent-name}
RETURN STATUS: 204
|
Adding placement intent for each application in the composite-app
POST
The manifest file contains the following:
manifest.yaml
...
1
2
3
4
5
6
7
...
---
version:
v1
type:
values:
"values_override.yaml"
configresource:
-
filepath
:
testfol/subdir/deployment.yaml
chartpath:
vault-consul-dev/templates/deployment.yaml
POST
...
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projectsproject/{project-name}/composite-apps/{composite-app-name}/{verisonversion}/compositegeneric-placement-profilesintent/{composite-profileintent-name}/profiles
POST BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},app-intents
POST BODY:
{
"specmetadata":{
"app-name": "<name>",
// Must match the name given in composite-apps/apps API "description":"<description>",
}
}
"userData1":"<user data>",
Multipart request containg tar.gz of the profile
RETURN STATUS: 201
RETURN BODY:
{
"userData2":"<user data>"
},
"metadataspec":{
"app-name":"<name>name",
"description":"<description>",
"userData1":"<user data>",
intent":{
"userData2allOf":"<user data>"
[
},
"spec":{
"app-name":{
"<name>", // Must match the name given in composite-apps/apps API
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | GET, DELETE |
---|
linenumbers | true |
---|
|
GET
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/composite-profiles/{composite-profile-name}/profiles/{profile-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"provider-name":"aws"
"cluster-name":"edge1"
},
{
"provider-name":"<name>aws",
"description
"cluster-name":"<description>edge2",
"userData1":"<user data>" },
"userData2":"<user data>"
},
"spec":{
"app-name": "<name>", // Must match the name given in composite-apps/apps API
}
}
Multipart response containing the tar.gz of the profile
DELETE
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/composite-profiles/{composite-profile-name}/profiles/{profile-name}
RETURN STATUS: 204 |
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intents
POST BODY:
{
"metadata":{
anyOf":[
{
"provider-name":"aws"
"cluster-label-name":"east-us1"
},
{
"provider-name":"<name>aws",
"description
"cluster-label-name":"<description>east-us2",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
]
"logical-cloud": "logical-cloud-name" //name of logical cloud to use for instantiation.}
The DCM API will provide the list of clusters]
that are part of the logical-cloud}
}
}
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"logicalapp-cloudname":"name",
"logical-cloud-name" //name of logical cloud to use for instantiation. The DCM API will provide the list of clusters that are part of the logical-cloud
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intents/{intent-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"intent":{
"allOf":[
{
"provider-name":"aws"
"cluster-name":"edge1"
},
{
"descriptionprovider-name":"<description>aws",
"userData1
"cluster-name":"<user data>edge2",
"userData2":"<user data>"
},
"spec":{
"logical-cloud": "logical-cloud-name" //name of logical cloud to use for instantiation. The DCM API will provide the list of clusters that are part of the logical-cloud
}
}
DELETE
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}
RETURN STATUS: 204
|
Adding placement intent for each application in the composite-app
POST
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}/app-intents
POST BODY:
{
"metadata":{
{
"anyOf":[
{
"provider-name":"aws"
"cluster-label-name":"east-us1"
},
{
"provider-name":"<name>aws",
"description
"cluster-label-name":"<description>east-us2",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"app-name":"name",
]
"intent":{ }
"allOf":[]
}
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}/app-intents
RETURN STATUS: 200
RETURN BODY:
{
"applications":[
{
{
"cluster-name":"edge1app1",
},
"anyOf":[
{
"provider-name":"aws"
"cluster-name":"edge2edge1"
},
{
"anyOfprovider-name":[
"aws"
"cluster-name":"edge2"
}
{
]
},
{
"cluster-label-name":"east-us1app2",
},
"allOf":[
{
"provider-name":"aws"
"cluster-label-name":"east-us2edge1"
},
}{
]
"provider-name":"aws"
"cluster-name":"edge2"
}
]
},
}
}
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>app3",
"descriptionallOf":"<description>",
[
"userData1":"<user data>", {
"userData2":"<user data>"
},
"specprovider-name":{
"app"aws"
"cluster-name":"nameedge1",
"intent":{
"allOf":[},
{
"provider-name":"aws"
"cluster-name":"edge1edge2"
},
{
"cluster-nameanyOf":"edge2"
[
},
{
{"provider-name":"aws"
"cluster-label-name":"east-us1"
"anyOf":[ },
{
"provider-name":"aws"
"cluster-label-name":"east-us1us2"
},
]
{
}
]
}
"cluster-label-name":"east-us2"
}
]
}
GET
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}/app-intents/{intent-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
]"description":"<description>",
}"userData1":"<user data>",
]
"userData2":"<user data>"
},
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}/app-intents
RETURN STATUS: 200
RETURN BODY:
{
"applications":[
{
"spec":{
"app-name":"name",
"intent":{
"allOf":[
{
"provider-name":"aws"
"cluster-name":"app1edge1",
"anyOf":[},
{
"provider-name":"aws"
"cluster-name":"edge1edge2"
},
{
"cluster-nameanyOf":"edge2"[
}
{
]
},
{
"provider-name":"aws"
"cluster-label-name":"app2east-us1",
"allOf":[
},
{
"cluster "provider-name":"aws"
"cluster-label-name":"edge1east-us2"
},
}
{
"cluster-name":"edge2"
]
}
]
},
}
}
GET (Query)
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}/app-intents?app-name=<app-name>
RETURN STATUS: 200
RETURN BODY:
{
"nameintent":"app3",
{
"allOf":[
{
"provider-name":"aws"
"cluster-name":"edge1"
},
{
"provider-name":"aws"
"cluster-name":"edge2"
},
{
"anyOf":[
{
"provider-name":"aws"
"cluster-label-name":"east-us1"
},
{
"provider-name":"aws"
"cluster-label-name":"east-us2"
}
]
}
]
}
]
}
DELETE
GET
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}/appapps-intents/{intent-name}
RETURN STATUS: 200
RETURN BODYSTATUS: 204
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec
|
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups
POST BODY:
{
"metadata":{
"app-name":"name<name>",
"intentdescription":{
"allOf":[
{
"<description>",
"cluster-name"userData1":"edge1<user data>",
"userData2":"<user data>"
},
"spec":{
{"profile":"<profile-name>",
"version":"<version of the deployment>",
"clusteroverride-namevalues":"edge2"[
},{
{
"app-name":"<name>",
"anyOfvalues":[
{
"cluster-label-nameimageRepository":"east-us1"
registry.hub.docker.com"
}
},]
},
{
"app-name":"<name>",
"cluster-label-namevalues":"east-us2"[
{
}
]"imageRepository":"registry.hub.docker.com"
}
]
}
}
}
DELETE
URL: /v2/project/{project-name}/composite-apps/{composite-app-name}/{version}/generic-placement-intent/{intent-name}/apps-intents/{intent-name}
RETURN STATUS: 204
|
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups
POST BODY:]
}
}
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"profile":"<profile-name>",
"version":"<version of the deployment>",
"override-values":[
{
"app-name":"<name>",
"values":[
{
"imageRepository":"registry.hub.docker.com"
}
]
},
{
"app-name":"<name>",
"values":[
{
"imageRepository":"registry.hub.docker.com"
}
]
}
]
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}
RETURN STATUS: 201200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"profile":"<profile-name>",
"version":"<version of the deployment>", the deployment>",
"status": "approved", // approved or not-approved
"override-values":[
{
"app-name":"<name>",
"values":[
{
"imageRepository":"registry.hub.docker.com",
"another_key":"another_value"
}
]
},
{
"app-name":"<name>",
"values":[
{
"imageRepository":"registry.hub.docker.com",
"another_key":"another_value"
}
]}
]
}
]
}
} |
...
}
}
DELETE
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}
RETURN STATUS: 204
|
Adding intents to an Intent group
POST
Code Block |
---|
language | js |
---|
title | Get, DeletePOST |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}
RETURN STATUS: 200
RETURN/intents
POST BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"profile":"<profile-name>",
"version":"<version of the deployment>",
"override-values":[
"spec":{
"intent":{
"appgeneric-placement-nameintent":"<name>",xyz-generic-placement-intent"
}
}
}
RETURN STATUS: "values":[
201
RETURN BODY:
{
"metadata":{
"name":"<name>",
{
"description":"<description>",
"userData1":"<user data>",
"imageRepositoryuserData2":"registry.hub.docker.com<user data>"
},
"spec":{
"intent":{ }
]"generic-placement-intent":"xyz-generic-placement-intent"
}
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
{URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name}
{
"metadata":{
"app-name":"<name>",
"valuesdescription":["<description>",
{
"userData1":"<user data>",
"imageRepositoryuserData2":"registry.hub.docker.com"
<user data>"
},
"spec":{
"intent":{ ]
}"generic-placement-intent":"xyz-generic-placement-intent"
]}
}
}
DELETEGET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents
RETURN STATUS: 200
RETURN BODY: 204
|
Adding intents to an Intent group
POST
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents
POST BODY:
{
"metadata":{
{
"intent":[
{
"generic-placement-intent":"generic-placement-intent-name"
},
{
"namehpa":"<name>"hpa-placement-intent-name"
},
"description":"<description>",
{
"userData1traffic":"<user data>",
"userData2":"<user data>"
},
"spec":{
"intent":{ traffic-intent-name"
}
]
}
GET (Query)
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents?intent=<intent>
{
"generic-placement-intent":"xyz-generic-placement-intent"
}
}
DELETE
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name}
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"intent":{
"generic":"xyz-generic-placement-intent"
}
}
} |
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/approve
POST BODY:
{
}
RETURN STATUS: 201
RETURN BODY:
{
}
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/instantiate
POST BODY:
{
}
RETURN STATUS: 201
RETURN BODY:
{
}
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/destroy
POST BODY:
{
}
RETURN STATUS: 201
RETURN BODY:
{
}
|
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name}
{
"metadata":{
status
POST BODY:
{
}
RETURN STATUS: 201
RETURN BODY:
{
"name": "<name>",
"composite-app-name": "test-app",
"descriptioncomposite-app-version": "<description>v1",
"userData1profile-name":"<user data> "test-app-profile",
"userData2intent-group":"<user data> "intent-group-1"
}"namespace": "testinstallns",
"specresources":{
[
{
"intentapp-name":{
"collectd",
"genericclusters":"xyz-generic-placement-intent" [
}{
}
}
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents
RETURN STATUS: 200
RETURN BODY:
{
"name": "cluster1",
"resources": [
{
"intentGVK":[ {
{
"generic-placement-intentGroup": "generic-placement-intent-name",
} "Version": "v1",
{
"hpa-placement-intentKind":"hpa-placement-intent-name"
"Service"
},
{
"traffic-intentName": "traffic-intent-namemongo",
}
]
}
DELETE
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name}
RETURN STATUS: 204
|
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
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/approve
POST BODY:
{
}
RETURN STATUS: 201
RETURN BODY:
{
}
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/initantiate
POST BODY:
{
}
RETURN STATUS: 201
RETURN BODY:
{
}
"status": "Running"
},
{
"GVK": {
"Group": "",
"Version": "v1",
"Kind": "Service"
},
"Name": "mongo-read",
"status": "Terminated"
}
]
}
]
}
]
Status Queries:
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/status
POST BODY:
{
}
RETURN STATUS: 201
RETURN BODY:
{
"name": "<name>",
"composite-app-name": "test-app",
"composite-app-version": "v1",
"profile-name": "test-app-profile",
"intent-group": "intent-group-1"
"namespace": "testinstallns",
"resources": [
{?output=<output-type>&app=<app-name>&cluster=<cluster-name>&resource=<resource-name>
output-type can be small or full.
Query can be a combination of the app, cluster and resources.
|
Cluster Registration API
API to support Reachability for a Kubernetes Cloud. This API will be used to upload configuration information for the cluster
POST
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/cluster-providers
POST BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"GVKuserData1": {
"Group": ""<user data>",
"VersionuserData2":"<user data>"v1",
}
}
RETURN STATUS: 201
RETURN BODY:
{
"Kindmetadata": "Service"{
}"name":"<name>",
"cluster-namedescription": "cluster1<description>",
"NameuserData1":"<user data>"mongo",
"statususerData2":"<user data>"Running"
},
{
"GVK": {
"Group": "",
"Version": "v1",}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/cluster-providers/{provider-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"Kindname": "Service"
}<name>",
"cluster-namedescription": "cluster2<description>",
"NameuserData1": "mongo-read"<user data>",
"statususerData2":"<user "Terminated"
}
]data>"
}
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/destroy
POST BODY:
{
} }
}
DELETE
URL: /v2/cluster-providers/{provider-name}
RETURN STATUS: 201
RETURN BODY:
{
} |
Cluster Registration API
API to support Reachability for a Kubernetes Cloud. This API will be used to upload configuration information for the cluster
POST
This POST is a multipart POST. With the POST body containing the data about the cluster and the kubeconfig uploaded in multipart form.
...
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/cluster-providers/{provider-name}/clusters
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
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/cluster-providers/{provider/cluster-providers/{provider-name}/clusters/{cluster-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
DELETE
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}
RETURN STATUS: 204
|
POST
...
Add Label to a cluster
POST
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/labels
POST BODY:
{
“label-name” "metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
: “<label>”
}
RETURN STATUS: 201
RETURN BODY:
{
“label-name” : “<label>”
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/labels/<label>
RETURN STATUS: 201200
RETURN BODY:
{
“label-name” : "metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
} |
...
“<label>”
}
GET (Query)
URL: /v2/cluster-providers/{provider-name}/clusters?label=<label>
RETURN STATUS: 200
RETURN BODY:
[<list of clusters>]
DELETE
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/labels/<label>
RETURN STATUS: 204
|
Add key-value pair to a cluster
Add property to a cluster without the need for change to the API.
POST
Code Block |
---|
language | js |
---|
title | Get, DeletePOST |
---|
linenumbers | true |
---|
|
GET
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}
RETURN STATUS: 200
RETURN BODY: /kv-pairs
POST BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
}
}
DELETE
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}
RETURN STATUS: 204
|
Add Label to a cluster
POST
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/labels
POST BODY:
{
“label-name” : “<label>”
}
RETURN STATUS: 201
RETURN BODY:
{
“label-name” : “<label>”
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/labels/<label>
RETURN STATUS: 200
RETURN BODY:
{
“label-name” : “<label>”
}
DELETE
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/labels/<label>
RETURN STATUS: 204
|
Add key-value pair to a cluster
Add property to a cluster without the need for change to the API.
POST
Code Block |
---|
language | js |
---|
title | POST |
---|
linenumbers | true |
---|
|
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/kv-pairs
POST BODY: },
"spec":{
"kv":[
{
"key1":"val1"
},
{
"key2":"val2"
}
]
}
}
RETURN STATUS: 201
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"kv":[
{
"key1":"val1"
},
{
"key2":"val2"
}
]
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
}
}
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/kv-pairs/<name>
RETURN STATUS: 201200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"kv":[
{
"key1":"val1"
},
{
"key2":"val2"
}
]
}
} |
GET, DELETE
Code Block |
---|
language | js |
---|
title | Get, Delete |
---|
linenumbers | true |
---|
|
GET
GET (Query)
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/kv-pairs/<name>?key=<key>
RETURN STATUS: 200
RETURN BODY:
{
"metadatavalue":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"kv":[
{
<value>"
}
DELETE
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/kv-pairs/<name>
RETURN STATUS: 204
|
Orchestrator Controller Registration API
This API allows controllers to register themselves as gRPC servers consumed by the orchestrator.
POST
Code Block |
---|
language | bash |
---|
title | POST |
---|
linenumbers | true |
---|
|
POST/PUT
URL: /v2/controllers
POST BODY:
{
"metadata":{
"key1name":"val1<name>",
}"description":"<description>",
{
"userData1":"<user data>",
"key2userData2":"val2<user data>"
},
"spec":{
]
}
}
GET
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/kv-pairs/key/<key>
RETURN STATUS: 200
RETURN BODY:
{
"value": "<value>"
}
DELETE
URL: /v2/cluster-providers/{provider-name}/clusters/{cluster-name}/kv-pairs/<name>
RETURN STATUS: 204
|
Orchestrator Controller Registration API
This API allows controllers to register themselves as gRPC servers consumed by the orchestrator.
IN-PROGRESS
"host": "10.7.100.4",
"port": 9029,
"type": "<type of controller>, // placement, action are 2 types supported
"priority": 2
}
} |
GET, DELETE
...
Code Block |
---|
language | bash |
---|
title | POSTGET, DELETE |
---|
linenumbers | true |
---|
|
POST/PUTGET
URL: /v2/controllers
POST BODY:
{
"name": "HPA-Placement-Controller",
/{controller-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"host": "10.7.100.4",
"port": 9029,
"type": "<type of controller>,
"priority": 8800
}
|
...
2
}
}
DELETE
URL: /v2/controllers/{controller-name}
RETURN STATUS: 204 |
Example CURL Command:
Code Block |
---|
language | bash |
---|
title | GET, DELETEPOST |
---|
linenumbers | true |
---|
|
curl -X GET "http://10.7.100.1:9015GET
URL: /v2/controllers/{controller-name}
RETURN STATUS: 200
RETURN BODY:
{
"name": "HPA-Placement-Controller",
"host": "hpa-placement-controller" -H "accept: */*" -H "Content-Type: application/json"
curl -X DELETE "http://10.7.100.4",
"port": 8800
}
DELETE
URL: 1:9015/v2/controllers/{controller-name}
RETURN STATUS: 204hpa-placement-controller" -H "accept: */*" |