hex.k8s.services.stateful ​
- Source: module
- Function count: 1
hex.k8s.services.stateful.build ​
Copy Call Skeleton ​
nix
(hex.k8s.services.stateful.build {
name = "build";
labels = { app = "build"; };
image = "TODO";
})Required Args ​
| Arg | Type | Notes |
|---|---|---|
name | unknown | - |
labels | unknown | - |
image | unknown | - |
Optional Args ​
| Arg | Type | Default | Notes |
|---|---|---|---|
namespace | string | "default" | - |
replicas | number | 1 | - |
ports | list | [ ] | services.ports entries; published on the headless Service and container |
exposure | null | null | optional client-facing Service from services.exposures |
claims | list | [ ] | services.claims.build entries, one PVC per replica each |
claimRetention | attrset | { whenDeleted = "Retain"; whenScaled = "Retain"; } | - |
podManagementPolicy | string | "OrderedReady" | - |
publishNotReadyAddresses | bool | true | lets peers discover each other before they are ready |
rollout | null | null | services.stateful.rollouts |
revisionHistoryLimit | number | 2 | - |
disruptionBudget | null | null | services.disruptions |
configs | list | [ ] | services.configs entries |
metrics | null | null | services.metrics.scrape; renders a pod monitor for the replicas |
warnings | bool | true | false silences hex evaluation warnings for this workload |
networkPolicy | bool | true | - |
egressPolicy | unknown | defaults.egressPolicy | - |
ingressPolicy | unknown | defaults.ingressPolicy | - |
serviceAccount | bool | true | - |
roleBinding | bool | false | - |
imagePullSecrets | list | [ ] | - |
suffix | string | "" | - |
stsSuffix | unknown | suffix | - |
saSuffix | unknown | defaultSaSuffix suffix | - |
headlessSuffix | string | "-headless${suffix}" | - |
serviceSuffix | string | "-service${suffix}" | - |
npSuffix | string | "-policy${suffix}" | - |
rbSuffix | string | "-role-binding-view${suffix}" | - |
pdbSuffix | string | "-pdb${suffix}" | - |
extraServiceAnnotations | attrset | { } | - |
extraServiceAccountAnnotations | attrset | { } | - |
extraStatefulSetAnnotations | attrset | { } | - |
extraStatefulSet | attrset | { } | - |