Skip to content

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 ​

ArgTypeNotes
nameunknown-
labelsunknown-
imageunknown-

Optional Args ​

ArgTypeDefaultNotes
namespacestring"default"-
replicasnumber1-
portslist[ ]services.ports entries; published on the headless Service and container
exposurenullnulloptional client-facing Service from services.exposures
claimslist[ ]services.claims.build entries, one PVC per replica each
claimRetentionattrset{ whenDeleted = "Retain"; whenScaled = "Retain"; }-
podManagementPolicystring"OrderedReady"-
publishNotReadyAddressesbooltruelets peers discover each other before they are ready
rolloutnullnullservices.stateful.rollouts
revisionHistoryLimitnumber2-
disruptionBudgetnullnullservices.disruptions
configslist[ ]services.configs entries
metricsnullnullservices.metrics.scrape; renders a pod monitor for the replicas
warningsbooltruefalse silences hex evaluation warnings for this workload
networkPolicybooltrue-
egressPolicyunknowndefaults.egressPolicy-
ingressPolicyunknowndefaults.ingressPolicy-
serviceAccountbooltrue-
roleBindingboolfalse-
imagePullSecretslist[ ]-
suffixstring""-
stsSuffixunknownsuffix-
saSuffixunknowndefaultSaSuffix suffix-
headlessSuffixstring"-headless${suffix}"-
serviceSuffixstring"-service${suffix}"-
npSuffixstring"-policy${suffix}"-
rbSuffixstring"-role-binding-view${suffix}"-
pdbSuffixstring"-pdb${suffix}"-
extraServiceAnnotationsattrset{ }-
extraServiceAccountAnnotationsattrset{ }-
extraStatefulSetAnnotationsattrset{ }-
extraStatefulSetattrset{ }-

Back to Helper Index