OsUpdateStatefulSetResources

Updates container resource requests and limits in a Kubernetes or OpenShift stateful set.

What It Does

Updates CPU and memory requests and limits on a stateful set container, then waits for the stateful rollout to converge.

This is useful when a scenario needs to change the resource profile of a stateful component without rebuilding or redeploying the whole environment manually.

YAML Example

Sessions:
  - Name: ProbeSession
    Probes:
      - Name: OsUpdateStatefulSetResourcesProbe
        Probe: OsUpdateStatefulSetResources
        ProbeConfiguration:
          UseGlobalDict: true
          ReplicaSetName: orders-worker
          ContainerName: worker
          IntervalBetweenDesiredStateChecksMs: 1000
          TimeoutWaitForDesiredStateSeconds: 300
          Openshift:
            Cluster: https://api.cluster.local:6443
            Namespace: docs
            Username: docs-user
            Password: docs-password
          DesiredResources:
            Limits:
              Cpu: 1500m
              Memory: 2Gi
            Requests:
              Cpu: 500m
              Memory: 512Mi

What This Configuration Does

This probe updates the worker container in the orders-worker stateful set so that it requests 500m CPU and 512Mi memory, with limits of 1500m CPU and 2Gi memory.

After the patch is applied, the probe waits for the stateful set to finish rolling out.

Global Dictionary Behavior

With UseGlobalDict: true, missing shared cluster settings can be resolved from Os/Defaults, and missing DesiredResources can be restored from Os/Recovery/Resources/StatefulSet/<ReplicaSetName>/<ContainerName> after an earlier probe in the same execution and session captured the pre-change state.

The probe writes its pre-change snapshot to the unique canonical scoped path for the current probe execution and then updates the recovery alias so a later rollback probe can reuse it. This is useful when you want to apply a temporary resource profile to a stateful workload and then restore it.

No additional per-probe recovery caveat applies beyond the execution and session scoping rules.

When UseGlobalDict is false, the probe keeps the current behavior: it uses only local YAML or code configuration and does not read or write probe-global-dictionary state.