/

StatefulSet Status

Analyze the current status of a Kubernetes StatefulSet


The statefulsetStatus analyzer is used to report on the number of replicas that are "Ready" in a statefulset. The when attribute supports standard comparators to compare the number of ready replicas.

The statefulsetStatus analyzer uses data from the clusterResources collector. The clusterResources collector is automatically added and will always be present.

The target statefulset can be identified by name. The outcomes on this analyzer will be processed in order, and execution will stop after the first outcome that is truthy.

Parameters

name: (Required) The name of the statefulset to check

namespace: (Required) The namespace to look for the statefulset in.

Example Analyzer Definition

apiVersion: troubleshoot.sh/v1beta2
kind: Preflight
metadata:
  name: redis-statefulset-running
spec:
  analyzers:
    - statefulsetStatus:
        name: redis
        namespace: default
        outcomes:
          - fail:
              when: "< 1"
              message: The redis statefulset does not have any ready replicas.
          - warn:
              when: "= 1"
              message: The redis statefulset has only a single ready replica.
          - pass:
              message: There are multiple replicas of the redis statefulset ready.

Note: troubleshoot.sh/v1beta2 was introduced in preflight and support-bundle krew plugin version 0.9.39 and Kots version 1.19.0. Kots vendors should read the guide to maintain backwards compatibility.

Edit on GitHub