This page explains how to inspect existing stateful workloads running in a Google Distributed Cloud (GDC) air-gapped appliance Kubernetes cluster. Stateful workloads let you run your application with persistent container storage. You can view your stateful workloads with the GDC console or the kubectl CLI to monitor resource usage and workload health.
This page is for developers within the application operator group, who are responsible for managing application workloads for their organization.
Before you begin
To run commands against the pre-configured bare metal Kubernetes cluster, make sure you have the following resources:
Locate the Kubernetes cluster name, or ask your Platform Administrator what the cluster name is.
Sign in and generate the kubeconfig file for the Kubernetes cluster if you don't have one.
Use the kubeconfig path of the Kubernetes cluster to replace
CLUSTER_KUBECONFIG
in these instructions.
To get the required permissions to view all workloads deployed in a project, ask
your Organization IAM Admin to grant you the Workload Viewer role
(workload-viewer
) in your project namespace.
To get the required permissions to inspect stateful workloads, ask your
Organization IAM Admin to grant you the Namespace Admin role (namespace-admin
)
in your project namespace.
View a project's container workloads
Run the following command to list all pods in your project:
kubectl get pods -n PROJECT_NAMESPACE
The output is similar to the following:
NAME READY STATUS RESTARTS AGE
nginx-workload-ah-aa-1228 1/1 Running 0 12h
nginx-workload-ah-ab-6784 1/1 Running 0 11h
nginx-workload-ah-ac-0045 1/1 Running 0 12h
Inspect a StatefulSet
resource
To request more detailed information about the components of a StatefulSet
resource, run commands that directly target the entity you're looking to
inspect.
Get StatefulSet
object information
To get detailed information about the StatefulSet
object, run:
kubectl --kubeconfig CLUSTER_KUBECONFIG -n NAMESPACE \
describe statefulset STATEFULSET_NAME
Replace the following:
CLUSTER_KUBECONFIG
: the kubeconfig file for the Kubernetes cluster running theStatefulSet
object.NAMESPACE
: the project namespace.STATEFULSET_NAME
: the name of theStatefulSet
object.
Display live configuration in YAML format
To display the live configuration of the StatefulSet
resource in YAML format,
run:
kubectl --kubeconfig CLUSTER_KUBECONFIG -n NAMESPACE \
get statefulset STATEFULSET_NAME -o yaml
Replace the following:
CLUSTER_KUBECONFIG
: the kubeconfig file for the Kubernetes cluster running theStatefulSet
object.NAMESPACE
: the project namespace.STATEFULSET_NAME
: the name of theStatefulSet
object.
List pods
To list the Pod
objects created by the StatefulSet
, run:
kubectl --kubeconfig CLUSTER_KUBECONFIG -n NAMESPACE \
get pods -l app=APP_NAME
In this command, the -l
flag lists all Pod
objects labeled with
APP_NAME
.
Replace the following:
CLUSTER_KUBECONFIG
: the kubeconfig file for the Kubernetes cluster running theStatefulSet
object.NAMESPACE
: the project namespace.APP_NAME
: the name of the stateful application managed by theStatefulSet
object.
Get specific pod information
To get information about a specific Pod
in the cluster, run:
kubectl --kubeconfig CLUSTER_KUBECONFIG -n NAMESPACE \
describe pod POD_NAME
Replace the following:
CLUSTER_KUBECONFIG
: the kubeconfig file for the Kubernetes cluster running the pod.NAMESPACE
: the project namespace.POD_NAME
: the name of the pod managed by theStatefulSet
object.
List PVCs
To list the PersistentVolumeClaim
(PVC) objects in the cluster, run:
kubectl --kubeconfig CLUSTER_KUBECONFIG -n NAMESPACE \
get pvc
Replace the following:
CLUSTER_KUBECONFIG
: the kubeconfig file of the Kubernetes cluster running the PVCs.NAMESPACE
: the project namespace.
Get specific PVC information
To get information about a specific PersistentVolumeClaim
(PVC) in the
cluster, run:
kubectl --kubeconfig CLUSTER_KUBECONFIG -n NAMESPACE \
describe pvc PVC_NAME
Replace the following:
CLUSTER_KUBECONFIG
: the kubeconfig file for the Kubernetes cluster running the PVC.NAMESPACE
: the project namespace.PVC_NAME
: the name of the PVC configured for theStatefulSet
object.
Get PV information
To get information about a specific PersistentVolume
(PV) in the cluster,
run:
kubectl --kubeconfig CLUSTER_KUBECONFIG -n NAMESPACE \
describe pv PV_NAME
Replace the following:
CLUSTER_KUBECONFIG
: the kubeconfig file for the Kubernetes cluster running the PV.NAMESPACE
: the project namespace.PV_NAME
: the name of the PV configured for theStatefulSet
object.