case class StatefulSetSpec(minReadySeconds: Optional[Int] = Optional.Absent, persistentVolumeClaimRetentionPolicy: Optional[StatefulSetPersistentVolumeClaimRetentionPolicy] = Optional.Absent, podManagementPolicy: Optional[String] = Optional.Absent, replicas: Optional[Int] = Optional.Absent, revisionHistoryLimit: Optional[Int] = Optional.Absent, selector: LabelSelector, serviceName: String, template: PodTemplateSpec, updateStrategy: Optional[StatefulSetUpdateStrategy] = Optional.Absent, volumeClaimTemplates: Optional[Vector[PersistentVolumeClaim]] = Optional.Absent) extends Product with Serializable

A StatefulSetSpec is the specification of a StatefulSet.

minReadySeconds

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.

podManagementPolicy

podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

replicas

replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

revisionHistoryLimit

revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

serviceName

serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.

volumeClaimTemplates

volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StatefulSetSpec
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StatefulSetSpec(minReadySeconds: Optional[Int] = Optional.Absent, persistentVolumeClaimRetentionPolicy: Optional[StatefulSetPersistentVolumeClaimRetentionPolicy] = Optional.Absent, podManagementPolicy: Optional[String] = Optional.Absent, replicas: Optional[Int] = Optional.Absent, revisionHistoryLimit: Optional[Int] = Optional.Absent, selector: LabelSelector, serviceName: String, template: PodTemplateSpec, updateStrategy: Optional[StatefulSetUpdateStrategy] = Optional.Absent, volumeClaimTemplates: Optional[Vector[PersistentVolumeClaim]] = Optional.Absent)

    minReadySeconds

    Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.

    podManagementPolicy

    podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

    replicas

    replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

    revisionHistoryLimit

    revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

    serviceName

    serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.

    volumeClaimTemplates

    volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. def getMinReadySeconds: IO[K8sFailure, Int]

    Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available.

    Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  9. def getPersistentVolumeClaimRetentionPolicy: IO[K8sFailure, StatefulSetPersistentVolumeClaimRetentionPolicy]

    Gets persistentVolumeClaimRetentionPolicy.

    Gets persistentVolumeClaimRetentionPolicy.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  10. def getPodManagementPolicy: IO[K8sFailure, String]

    podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.

    podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  11. def getReplicas: IO[K8sFailure, Int]

    replicas is the desired number of replicas of the given Template.

    replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  12. def getRevisionHistoryLimit: IO[K8sFailure, Int]

    revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history.

    revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  13. def getSelector: IO[K8sFailure, LabelSelector]

    Gets selector.

    Gets selector.

    This effect always succeeds, it is safe to use the field selector directly.

  14. def getServiceName: IO[K8sFailure, String]

    serviceName is the name of the service that governs this StatefulSet.

    serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.

    This effect always succeeds, it is safe to use the field serviceName directly.

  15. def getTemplate: IO[K8sFailure, PodTemplateSpec]

    Gets template.

    Gets template.

    This effect always succeeds, it is safe to use the field template directly.

  16. def getUpdateStrategy: IO[K8sFailure, StatefulSetUpdateStrategy]

    Gets updateStrategy.

    Gets updateStrategy.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  17. def getVolumeClaimTemplates: IO[K8sFailure, Vector[PersistentVolumeClaim]]

    volumeClaimTemplates is a list of claims that pods are allowed to reference.

    volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val minReadySeconds: Optional[Int]
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val persistentVolumeClaimRetentionPolicy: Optional[StatefulSetPersistentVolumeClaimRetentionPolicy]
  24. val podManagementPolicy: Optional[String]
  25. val replicas: Optional[Int]
  26. val revisionHistoryLimit: Optional[Int]
  27. val selector: LabelSelector
  28. val serviceName: String
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. val template: PodTemplateSpec
  31. val updateStrategy: Optional[StatefulSetUpdateStrategy]
  32. val volumeClaimTemplates: Optional[Vector[PersistentVolumeClaim]]
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped