...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET
URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}
RETURN STATUS: 200
RETURN BODY:
{
"metadata":{
"name":"<name>",
"description":"<description>",
"userData1":"<user data>",
"userData2":"<user data>"
},
"spec":{
"profile":"<profile-name>",
"version":"<version of 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
|
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET URL: /v2/projects/{project-name}/composite-apps/{composite-app-name}/{version}/deployment-intent-groups/{deployment-intent-group-name}/intents/{intent-name} { "metadata":{ "name":"<name>", "description":"<description>", "userData1":"<user data>", "userData2":"<user data>" }, "spec":{ "intent":{ "generic-placement-intent":"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: { "intent":[ { "generic-placement-intent":"generic-placement-intent-name" }, { "hpa-placement-intent":"hpa-placement-intent-name" }, { "traffic-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: 204 |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
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: { } 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": [ { "app-name": "collectd", "clusters": [ { "cluster-name": "cluster1", "resources": [ { "GVK": { "Group": "", "Version": "v1", "Kind": "Service" }, "cluster-name": "cluster1", "Name": "mongo", "status": "Running" }, { "GVK": { "Group": "", "Version": "v1", "Kind": "Service" }, "cluster-name": "cluster2", "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?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. |
...