Skip to main content

Pod Replica Count Check

Last updated on

Pod Replica Count Check is a built-in Command Probe template that validates whether a Kubernetes workload keeps at least a minimum number of healthy replicas during a chaos experiment. Use it to confirm that a Deployment, StatefulSet, or DaemonSet maintains availability while a fault removes or disrupts pods. You select the workload by label, by name, or by the owning workload kind and namespace.

The probe runs the healthchecks utility bundled in the chaos probe image, queries the Kubernetes API, and prints [Pass] when the workload has at least MINIMUM_HEALTHY_REPLICA_COUNT healthy replicas. The comparator marks the probe as passed when the output contains [Pass].

Built-in probe template

This is a built-in Command Probe template that runs on Kubernetes chaos infrastructure. Add it to an experiment from the probe library and customize its inputs. Go to Built-in probe templates to browse the full library, or go to Command probe to understand how command probes work.


Use cases

Use this probe template to:

  • Verify that deployments maintain the desired replica count.
  • Validate auto-scaling behavior during load chaos.
  • Monitor application availability during pod failures.
  • Confirm high availability during chaos experiments.

How the probe works

The template configures a Command Probe that runs healthchecks -name validate-pod-replica. The utility resolves the target workloads from TARGET_LABELS, TARGET_NAMES, TARGET_KIND, and TARGET_NAMESPACE, queries the Kubernetes API, and prints [Pass] when the number of healthy replicas is at or above MINIMUM_HEALTHY_REPLICA_COUNT. The comparator passes the probe when the output contains [Pass], and fails it otherwise.


Prerequisites

  • Chaos infrastructure: A Kubernetes chaos infrastructure installed in the target cluster.
  • Namespace access: Access to the target namespace and resources.
  • RBAC permissions: Permissions for the chaos service account to query resource status.

Probe properties

Command

healthchecks -name validate-pod-replica

Comparator

TypeCriteriaValue
stringcontains[Pass]

The probe passes when the command output contains [Pass], which indicates that the workload has at least the minimum required healthy replicas.

Environment variables

VariableDescriptionRequiredDefault
TARGET_LABELSComma-separated list of labels used to filter resources (for example, app=nginx,tier=frontend).No-
TARGET_NAMESComma-separated list of target resource names.No-
TARGET_NAMESPACENamespace of the target resources.Yes-
TARGET_KINDKind of the target resource (for example, deployment, statefulset, daemonset).Nodeployment
MINIMUM_HEALTHY_REPLICA_COUNTMinimum healthy replica count required for the target.No1
STATUS_CHECK_TIMEOUTMaximum time in seconds to wait for the status check.No180
STATUS_CHECK_DELAYDelay in seconds between status checks.No2

Run properties

PropertyDescriptionTypeDefault
timeoutMaximum time to wait for the probe to complete (for example, 30s, 1m, 5m).String180s
intervalTime between probe executions (for example, 1s, 5s, 10s).String1s
attemptNumber of retry attempts before the probe is marked as failed.Integer1
pollingIntervalTime between retry attempts (for example, 1s, 5s, 10s).String-
initialDelayInitial delay before the probe starts (for example, 0s, 10s, 30s).String-
stopOnFailureStop the experiment if the probe fails.Booleanfalse
verbosityLog verbosity level (info, debug, trace).String-

Troubleshooting

Pod Replica Count Check probe fails because the workload dropped below the minimum

The number of healthy replicas is below MINIMUM_HEALTHY_REPLICA_COUNT, which usually means the injected fault removed more pods than the workload could replace in time. Inspect the workload with kubectl get deployment or kubectl describe to confirm replica counts, check whether the cluster has capacity to schedule replacements, and increase STATUS_CHECK_TIMEOUT so the probe waits for recovery.

Pod Replica Count Check probe fails because no resources matched the target

The selectors did not resolve any workloads. Confirm that TARGET_LABELS, TARGET_NAMES, and TARGET_NAMESPACE match the workload, and that TARGET_KIND matches the resource type (deployment, statefulset, or daemonset). An empty match is treated as a failure.

Pod Replica Count Check probe fails with a forbidden or RBAC error

The chaos service account does not have permission to read the target workload in the namespace. Grant get and list on the relevant resource type (deployments, statefulsets, or daemonsets) and on pods for the chaos service account, then rerun the experiment.