describe-deployment¶

Description¶

Gets a single deployment along with its extended history. This can also include all of the known templates.

Synopsis¶

  describe-deployment
--cluster-crn <value>
--namespace <value>
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-crn (string)

Compute cluster CRN.

--namespace (string)

The namespace of the deployment.

--name (string)

The name of the deployment.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

deployment -> (object)

Deployment structure.

name -> (string)

The name of the deployment.

namespace -> (string)

The namespace of the deployment.

revision -> (integer)

Helm revision.

liftieManaged -> (boolean)

True if Liftie is managing this deployment.

chart -> (object)

Chart structure.

applicationVersion -> (string)

The version (usually of the images) of the components being deployed.

deploymentVersion -> (string)

The version of this chart (which is not the version of the components being deployed).

description -> (string)

The chart description.

name -> (string)

The chart name.

values -> (string)

Escaped JSON for values.yaml of that chart.

status -> (string)

Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future.

upgrades -> (array)

Any upgrades available for this deployment.

item -> (object)

Available deployment upgrade structure.

applicationVersion -> (string)

The version of the components which would be installed from this deployment.

deploymentVersion -> (string)

The version of the deployment that is available to upgrade to.

overrides -> (string)

Escaped JSON overrides for the deployment’s properties.

history -> (array)

History of the deployment.

item -> (object)

History structure.

revision -> (integer)

Helm revision.

status -> (string)

Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future.

chart -> (object)

Chart structure.

applicationVersion -> (string)

The version (usually of the images) of the components being deployed.

deploymentVersion -> (string)

The version of this chart (which is not the version of the components being deployed).

description -> (string)

The chart description.

name -> (string)

The chart name.

values -> (string)

Escaped JSON for values.yaml of that chart.

overrides -> (string)

Escaped JSON overrides for the deployment’s properties for given revision.

Form Factors¶

public, private