Page cover

deployment

The describe deployment command retrieves detailed information about a specific Deployment in the Kubernetes cluster. This includes metadata, replica status, rollout history, update strategy, and associated pods.

Usage

cldkctl describe deployment [name] [flags]

Steps

Follow the steps below to run and view the result of this command:

  1. Run the following command in your terminal:

./cldkctl describe deployment [name] 
  1. Replace [name] with the Deployment name you want to inspect.

  2. To view the resource name, refer to the corresponding get deployment section.

  3. If the resource is located in a non-default namespace, include the -n or --namespace flag followed by the namespace name.

./cldkctl describe [resource] [name] -n [namespace]
  1. Once completed successfully, the detailed information about the specified Deployment will appear in your terminal. The output includes metadata, specifications, container configurations, update strategy, and rollout status.

The following table describes the additional fields specific to the Deployment resource.

Column
Description

spec.replicas

The desired number of pod replicas for the Deployment.

spec.selector

Defines the label selector used to identify the pods managed by the Deployment.

spec.template

Describes the pod template used to create pods for this Deployment.

spec.template.spec.containers

Lists the containers that will be deployed as part of this Deployment.

spec.template.spec.containers.name

The name of the container.

spec.template.spec.containers.image

The container image used by the Deployment.

spec.strategy

Defines the strategy used to replace old pods with new ones during updates.

spec.strategy.type

The type of deployment strategy.

spec.strategy.rollingUpdate

Contains parameters controlling the rolling update process.

status.replicas

The total number of pods created by the Deployment.

status.updatedReplicas

The number of pods updated to the latest version of the Deployment.

status.unavailableReplicas

The number of pods that are not yet available.

status.conditions

Indicates the current conditions of the Deployment.

status.conditions.message

Provides additional information about the current Deployment state or issues.

Flags

  1. This command supports global flags. Refer to the Global Flags section for details.

  2. For common metadata fields, refer to the Common Output Fields table at the beginning of this section.

Flag
Description

-h, --help

Help for describe deployment command.

Last updated