Jump to

• Request
• Response

Deploy a Helm Chart

post

/api/microservice/Deploy

Deploys a version of a Helm chart inside a cluster and namespace.
The minimum required properties in the request body are:

• Cluster
• Namespace
• Helmchart
• ReleaseName
• Version

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• cluster(required): string
  cluster Name

  Example: cluster-1
• CustomValues: string
  Custom Values

  Example: # Default values for example-poller/n/nglobal:/n imageRegistry: replicaCount: 1/n/nimage:/n
• Helmchart(required): string
  The name of the Helm chart package

  Example: example-poller
• Namespace(required): string
  Logical grouping of resources within a cluster

  Example: kube-system
• ReleaseName(required): string
  - Release name for the installed Helm chart. - 53 chars max and the release name must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`

  Example: example-poller-deploy
• Version(required): string
  Version of Helm chart

  Example: 6.0.3

{
    "properties":{
        "cluster":{
            "description":"cluster Name",
            "type":"string",
            "example":"cluster-1"
        },
        "CustomValues":{
            "description":"Custom Values",
            "type":"string",
            "example":"# Default values for example-poller/n/nglobal:/n  imageRegistry: replicaCount: 1/n/nimage:/n"
        },
        "Helmchart":{
            "description":"The name of the Helm chart package",
            "type":"string",
            "example":"example-poller"
        },
        "Namespace":{
            "description":"Logical grouping of resources within a cluster",
            "type":"string",
            "example":"kube-system"
        },
        "ReleaseName":{
            "description":"- Release name for the installed Helm chart. \n- 53 chars max and the release name must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`",
            "type":"string",
            "example":"example-poller-deploy"
        },
        "Version":{
            "description":"Version of Helm chart",
            "type":"string",
            "example":"6.0.3"
        }
    },
    "required":[
        "cluster",
        "Namespace",
        "Helmchart",
        "Version",
        "ReleaseName"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
  Records array
• message: array message
  The response message.
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"array",
            "items":{
            },
            "example":[
                "NAME: example-poller",
                "LAST DEPLOYED: Sat Oct 21 11:22:51 2023",
                "NAMESPACE: a1-management",
                "STATUS: deployed",
                "REVISION: 1",
                "TEST SUITE: None"
            ]
        },
        "data":{
            "description":"Records array",
            "type":"array",
            "items":{
            },
            "example":[
                [
                    "Service",
                    "example-poller"
                ],
                [
                    "Deployment",
                    "example-poller"
                ]
            ]
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

Records array

Show Source

• Array of:

{
    "description":"Records array",
    "type":"array",
    "items":{
    },
    "example":[
        [
            "Service",
            "example-poller"
        ],
        [
            "Deployment",
            "example-poller"
        ]
    ]
}

Example:

[
    [
        "Service",
        "example-poller"
    ],
    [
        "Deployment",
        "example-poller"
    ]
]

Nested Schema : message

Type: array

The response message.

Show Source

• Array of:

{
    "description":"The response message.",
    "type":"array",
    "items":{
    },
    "example":[
        "NAME: example-poller",
        "LAST DEPLOYED: Sat Oct 21 11:22:51 2023",
        "NAMESPACE: a1-management",
        "STATUS: deployed",
        "REVISION: 1",
        "TEST SUITE: None"
    ]
}

Example:

[
    "NAME: example-poller",
    "LAST DEPLOYED: Sat Oct 21 11:22:51 2023",
    "NAMESPACE: a1-management",
    "STATUS: deployed",
    "REVISION: 1",
    "TEST SUITE: None"
]

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top