Package io.fabric8.kubernetes.api.model.apps

Class StatefulSetSpec

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<StatefulSetSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class StatefulSetSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<StatefulSetSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    A StatefulSetSpec is the specification of a StatefulSet.
    See Also:
    Serialized Form

    • Method Detail

      • getMinReadySeconds

        public Integer getMinReadySeconds()
        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)

      • setMinReadySeconds

        public void setMinReadySeconds​(Integer 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)

      • getOrdinals

        public StatefulSetOrdinals getOrdinals()
        A StatefulSetSpec is the specification of a StatefulSet.

      • setOrdinals

        public void setOrdinals​(StatefulSetOrdinals ordinals)
        A StatefulSetSpec is the specification of a StatefulSet.

      • setPersistentVolumeClaimRetentionPolicy

        public void setPersistentVolumeClaimRetentionPolicy​(StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy)
        A StatefulSetSpec is the specification of a StatefulSet.

      • getPodManagementPolicy

        public String getPodManagementPolicy()
        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.

      • setPodManagementPolicy

        public void setPodManagementPolicy​(String 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.

      • getReplicas

        public Integer getReplicas()
        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.

      • setReplicas

        public void setReplicas​(Integer 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.

      • getRevisionHistoryLimit

        public Integer getRevisionHistoryLimit()
        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.

      • setRevisionHistoryLimit

        public void setRevisionHistoryLimit​(Integer 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.

      • getSelector

        public io.fabric8.kubernetes.api.model.LabelSelector getSelector()
        A StatefulSetSpec is the specification of a StatefulSet.

      • setSelector

        public void setSelector​(io.fabric8.kubernetes.api.model.LabelSelector selector)
        A StatefulSetSpec is the specification of a StatefulSet.

      • getServiceName

        public String getServiceName()
        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.

      • setServiceName

        public void setServiceName​(String 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.

      • getTemplate

        public io.fabric8.kubernetes.api.model.PodTemplateSpec getTemplate()
        A StatefulSetSpec is the specification of a StatefulSet.

      • setTemplate

        public void setTemplate​(io.fabric8.kubernetes.api.model.PodTemplateSpec template)
        A StatefulSetSpec is the specification of a StatefulSet.

      • getUpdateStrategy

        public StatefulSetUpdateStrategy getUpdateStrategy()
        A StatefulSetSpec is the specification of a StatefulSet.

      • setUpdateStrategy

        public void setUpdateStrategy​(StatefulSetUpdateStrategy updateStrategy)
        A StatefulSetSpec is the specification of a StatefulSet.

      • getVolumeClaimTemplates

        public List<io.fabric8.kubernetes.api.model.PersistentVolumeClaim> getVolumeClaimTemplates()
        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.

      • setVolumeClaimTemplates

        public void setVolumeClaimTemplates​(List<io.fabric8.kubernetes.api.model.PersistentVolumeClaim> 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.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)