Skip to content

k8s get-deployment

describe deployment

Description

describes k8s deployment

Synopsis

k8s get-deployment
    [--site <site>]
    [--cluster <cluster>]
    [--namespace|-n <namespace>]
    <name>

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

cluster - (string)

     Cluster where this command will be executed
     Example: --cluster "in-cluster"
     Default: in-cluster      Attributes: optional

namespace - (string)

     Kubernetes namespace
     Example: --namespace "namespace-1"
     Default: default      Attributes: optional

name - (string)

     Name of the deployment
     Example: "name-1"
     Default: _None_      Attributes: required

Examples

Input: 

! k8s get-deployment "kafka1"
Output: 
{
    "cluster": "minikube",
    "namespace": "default",
    "name": "kafka1",
    "labels": {
        "app": "kafka1"
    },
    "annotations": {
        "deployment.kubernetes.io/revision": "1"
    },
    "deployment_status": {
        "replicas": 1,
        "updated_replicas": 1,
        "unavailable_replicas": 1,
        "deployment_conditions": [
            {
                "type": 3,
                "condition_status": 1,
                "reason": "NewReplicaSetAvailable",
                "message": "ReplicaSet \"kafka1-7cb95d9db6\" has successfully progressed."
            },
            {
                "type": 2,
                "condition_status": 2,
                "reason": "MinimumReplicasUnavailable",
                "message": "Deployment does not have minimum availability."
            }
        ]
    },
    "creation_time_millis": 1629190296000
}

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "k8s"
Service Instance cluster
Namespace namespace
Object Type "deployment"
Object ID name

Please see Access Control for details.