Skip to content

k8s get-statefulset

describe statefulset

Description

describes k8s statefulset

Synopsis

k8s get-statefulset
    [--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 statefulset
     Example: "name-1"
     Default: _None_      Attributes: required

Examples

Input: 

x = !k8s get-statefulset "temporaltest-cassandra"
Output: 
{
    "cluster": "in-cluster",
    "namespace": "default",
    "name": "temporaltest-cassandra",
    "labels": {
        "app": "cassandra",
        "app.kubernetes.io/managed-by": "Helm",
        "chart": "cassandra-0.14.3",
        "heritage": "Helm",
        "release": "temporaltest"
    },
    "annotations": {
        "autopilot.gke.io/resource-adjustment": "{\"input\":{\"containers\":[{\"name\":\"temporaltest-cassandra\"}]},\"output\":{\"containers\":[{\"limits\":{\"cpu\":\"500m\",\"ephemeral-storage\":\"1Gi\",\"memory\":\"2Gi\"},\"requests\":{\"cpu\":\"500m\",\"ephemeral-storage\":\"1Gi\",\"memory\":\"2Gi\"},\"name\":\"temporaltest-cassandra\"}]},\"modified\":true}",
        "meta.helm.sh/release-name": "temporaltest",
        "meta.helm.sh/release-namespace": "default"
    },
    "status": {
        "replicas": 1,
        "updated_replicas": 1,
        "ready_replicas": 1
    },
    "creation_time_millis": 1632240106000
}

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 "statefulset"
Object ID name

Please see Access Control for details.