package v1
- Alphabetic
- Public
- Protected
Type Members
- case class ControllerRevision(revision: Long, apiVersion: Option[String] = None, data: Option[RawExtension] = None, kind: Option[String] = None, metadata: Option[ObjectMeta] = None) extends Product with Serializable
ControllerRevision implements an immutable snapshot of state data.
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
- revision
Revision indicates the revision of the state represented by Data.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- data
Data is the serialized representation of the state.
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- case class ControllerRevisionList(items: Seq[ControllerRevision], apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ListMeta] = None) extends Product with Serializable
ControllerRevisionList is a resource containing a list of ControllerRevision objects.
ControllerRevisionList is a resource containing a list of ControllerRevision objects.
- items
Items is the list of ControllerRevisions
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- case class DaemonSet(apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ObjectMeta] = None, spec: Option[DaemonSetSpec] = None, status: Option[DaemonSetStatus] = None) extends Product with Serializable
DaemonSet represents the configuration of a daemon set.
DaemonSet represents the configuration of a daemon set.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- status
The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- case class DaemonSetCondition(type: String, status: String, lastTransitionTime: Option[Time] = None, message: Option[String] = None, reason: Option[String] = None) extends Product with Serializable
DaemonSetCondition describes the state of a DaemonSet at a certain point.
DaemonSetCondition describes the state of a DaemonSet at a certain point.
- status
Status of the condition, one of True, False, Unknown.
- lastTransitionTime
Last time the condition transitioned from one status to another.
- message
A human readable message indicating details about the transition.
- reason
The reason for the condition's last transition.
- case class DaemonSetList(items: Seq[DaemonSet], apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ListMeta] = None) extends Product with Serializable
DaemonSetList is a collection of daemon sets.
DaemonSetList is a collection of daemon sets.
- items
A list of daemon sets.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- case class DaemonSetSpec(selector: LabelSelector, template: PodTemplateSpec, minReadySeconds: Option[Int] = None, revisionHistoryLimit: Option[Int] = None, updateStrategy: Option[DaemonSetUpdateStrategy] = None) extends Product with Serializable
DaemonSetSpec is the specification of a daemon set.
DaemonSetSpec is the specification of a daemon set.
- selector
A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- template
An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
- minReadySeconds
The minimum number of seconds for which a newly created DaemonSet 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).
- revisionHistoryLimit
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
- updateStrategy
An update strategy to replace existing DaemonSet pods with new pods.
- case class DaemonSetStatus(currentNumberScheduled: Int, numberMisscheduled: Int, desiredNumberScheduled: Int, numberReady: Int, collisionCount: Option[Int] = None, conditions: Option[Seq[DaemonSetCondition]] = None, numberAvailable: Option[Int] = None, numberUnavailable: Option[Int] = None, observedGeneration: Option[Long] = None, updatedNumberScheduled: Option[Int] = None) extends Product with Serializable
DaemonSetStatus represents the current status of a daemon set.
DaemonSetStatus represents the current status of a daemon set.
- currentNumberScheduled
The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
- numberMisscheduled
The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
- desiredNumberScheduled
The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
- numberReady
numberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running with a Ready Condition.
- collisionCount
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision
- conditions
Represents the latest available observations of a DaemonSet's current state.
- numberAvailable
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
- numberUnavailable
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
- observedGeneration
The most recent generation observed by the daemon set controller.
- updatedNumberScheduled
The total number of nodes that are running updated daemon pod
- case class DaemonSetUpdateStrategy(rollingUpdate: Option[RollingUpdateDaemonSet] = None, type: Option[String] = None) extends Product with Serializable
DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
- rollingUpdate
Rolling update config params. Present only if type = "RollingUpdate".
- case class Deployment(apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ObjectMeta] = None, spec: Option[DeploymentSpec] = None, status: Option[DeploymentStatus] = None) extends Product with Serializable
Deployment enables declarative updates for Pods and ReplicaSets.
Deployment enables declarative updates for Pods and ReplicaSets.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Specification of the desired behavior of the Deployment.
- status
Most recently observed status of the Deployment.
- case class DeploymentCondition(type: String, status: String, lastTransitionTime: Option[Time] = None, lastUpdateTime: Option[Time] = None, message: Option[String] = None, reason: Option[String] = None) extends Product with Serializable
DeploymentCondition describes the state of a deployment at a certain point.
DeploymentCondition describes the state of a deployment at a certain point.
- status
Status of the condition, one of True, False, Unknown.
- lastTransitionTime
Last time the condition transitioned from one status to another.
- lastUpdateTime
The last time this condition was updated.
- message
A human readable message indicating details about the transition.
- reason
The reason for the condition's last transition.
- case class DeploymentList(items: Seq[Deployment], apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ListMeta] = None) extends Product with Serializable
DeploymentList is a list of Deployments.
DeploymentList is a list of Deployments.
- items
Items is the list of Deployments.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard list metadata.
- case class DeploymentSpec(selector: LabelSelector, template: PodTemplateSpec, minReadySeconds: Option[Int] = None, paused: Option[Boolean] = None, progressDeadlineSeconds: Option[Int] = None, replicas: Option[Int] = None, revisionHistoryLimit: Option[Int] = None, strategy: Option[DeploymentStrategy] = None) extends Product with Serializable
DeploymentSpec is the specification of the desired behavior of the Deployment.
DeploymentSpec is the specification of the desired behavior of the Deployment.
- selector
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
- template
Template describes the pods that will be created.
- 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)
- paused
Indicates that the deployment is paused.
- progressDeadlineSeconds
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
- replicas
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
- revisionHistoryLimit
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
- strategy
The deployment strategy to use to replace existing pods with new ones.
- case class DeploymentStatus(availableReplicas: Option[Int] = None, collisionCount: Option[Int] = None, conditions: Option[Seq[DeploymentCondition]] = None, observedGeneration: Option[Long] = None, readyReplicas: Option[Int] = None, replicas: Option[Int] = None, unavailableReplicas: Option[Int] = None, updatedReplicas: Option[Int] = None) extends Product with Serializable
DeploymentStatus is the most recently observed status of the Deployment.
DeploymentStatus is the most recently observed status of the Deployment.
- availableReplicas
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment
- collisionCount
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
- conditions
Represents the latest available observations of a deployment's current state.
- observedGeneration
The generation observed by the deployment controller.
- readyReplicas
readyReplicas is the number of pods targeted by this Deployment with a Ready Condition.
- replicas
Total number of non-terminated pods targeted by this deployment (their labels match the selector)
- unavailableReplicas
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
- updatedReplicas
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
- case class DeploymentStrategy(rollingUpdate: Option[RollingUpdateDeployment] = None, type: Option[String] = None) extends Product with Serializable
DeploymentStrategy describes how to replace existing pods with new ones.
DeploymentStrategy describes how to replace existing pods with new ones.
- rollingUpdate
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
- case class ReplicaSet(apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ObjectMeta] = None, spec: Option[ReplicaSetSpec] = None, status: Option[ReplicaSetStatus] = None) extends Product with Serializable
ReplicaSet ensures that a specified number of pod replicas are running at any given time.
ReplicaSet ensures that a specified number of pod replicas are running at any given time.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- status
Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- case class ReplicaSetCondition(type: String, status: String, lastTransitionTime: Option[Time] = None, message: Option[String] = None, reason: Option[String] = None) extends Product with Serializable
ReplicaSetCondition describes the state of a replica set at a certain point.
ReplicaSetCondition describes the state of a replica set at a certain point.
- status
Status of the condition, one of True, False, Unknown.
- lastTransitionTime
The last time the condition transitioned from one status to another.
- message
A human readable message indicating details about the transition.
- reason
The reason for the condition's last transition.
- case class ReplicaSetList(items: Seq[ReplicaSet], apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ListMeta] = None) extends Product with Serializable
ReplicaSetList is a collection of ReplicaSets.
ReplicaSetList is a collection of ReplicaSets.
- items
List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- case class ReplicaSetSpec(selector: LabelSelector, minReadySeconds: Option[Int] = None, replicas: Option[Int] = None, template: Option[PodTemplateSpec] = None) extends Product with Serializable
ReplicaSetSpec is the specification of a ReplicaSet.
ReplicaSetSpec is the specification of a ReplicaSet.
- selector
Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- 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)
- replicas
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
- template
Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
- case class ReplicaSetStatus(replicas: Int, availableReplicas: Option[Int] = None, conditions: Option[Seq[ReplicaSetCondition]] = None, fullyLabeledReplicas: Option[Int] = None, observedGeneration: Option[Long] = None, readyReplicas: Option[Int] = None) extends Product with Serializable
ReplicaSetStatus represents the current status of a ReplicaSet.
ReplicaSetStatus represents the current status of a ReplicaSet.
- replicas
Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
- availableReplicas
The number of available replicas (ready for at least minReadySeconds) for this replica set.
- conditions
Represents the latest available observations of a replica set's current state.
- fullyLabeledReplicas
The number of pods that have labels matching the labels of the pod template of the replicaset
- observedGeneration
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
- readyReplicas
readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition.
- case class RollingUpdateDaemonSet(maxSurge: Option[IntOrString] = None, maxUnavailable: Option[IntOrString] = None) extends Product with Serializable
Spec to control the desired behavior of daemon set rolling update.
Spec to control the desired behavior of daemon set rolling update.
- maxSurge
The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption.
- maxUnavailable
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
- case class RollingUpdateDeployment(maxSurge: Option[IntOrString] = None, maxUnavailable: Option[IntOrString] = None) extends Product with Serializable
Spec to control the desired behavior of rolling update.
Spec to control the desired behavior of rolling update.
- maxSurge
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
- maxUnavailable
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
- case class RollingUpdateStatefulSetStrategy(maxUnavailable: Option[IntOrString] = None, partition: Option[Int] = None) extends Product with Serializable
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
- maxUnavailable
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable.
- partition
Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.
- case class StatefulSet(apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ObjectMeta] = None, spec: Option[StatefulSetSpec] = None, status: Option[StatefulSetStatus] = None) extends Product with Serializable
StatefulSet represents a set of pods with consistent identities.
StatefulSet represents a set of pods with consistent identities. Identities are defined as:
- Network: A single stable DNS and hostname.
- Storage: As many VolumeClaims as requested.
The StatefulSet guarantees that a given network identity will always map to the same storage identity.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec
Spec defines the desired identities of pods in this set.
- status
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
- case class StatefulSetCondition(type: String, status: String, lastTransitionTime: Option[Time] = None, message: Option[String] = None, reason: Option[String] = None) extends Product with Serializable
StatefulSetCondition describes the state of a statefulset at a certain point.
StatefulSetCondition describes the state of a statefulset at a certain point.
- status
Status of the condition, one of True, False, Unknown.
- lastTransitionTime
Last time the condition transitioned from one status to another.
- message
A human readable message indicating details about the transition.
- reason
The reason for the condition's last transition.
- case class StatefulSetList(items: Seq[StatefulSet], apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ListMeta] = None) extends Product with Serializable
StatefulSetList is a collection of StatefulSets.
StatefulSetList is a collection of StatefulSets.
- items
Items is the list of stateful sets.
- apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- metadata
Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- case class StatefulSetPersistentVolumeClaimRetentionPolicy(whenDeleted: Option[String] = None, whenScaled: Option[String] = None) extends Product with Serializable
StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.
StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.
- whenDeleted
WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of
Retaincauses PVCs to not be affected by StatefulSet deletion. TheDeletepolicy causes those PVCs to be deleted.- whenScaled
WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of
Retaincauses PVCs to not be affected by a scaledown. TheDeletepolicy causes the associated PVCs for any excess pods above the replica count to be deleted.
- case class StatefulSetSpec(selector: LabelSelector, template: PodTemplateSpec, serviceName: String, minReadySeconds: Option[Int] = None, persistentVolumeClaimRetentionPolicy: Option[StatefulSetPersistentVolumeClaimRetentionPolicy] = None, podManagementPolicy: Option[String] = None, replicas: Option[Int] = None, revisionHistoryLimit: Option[Int] = None, updateStrategy: Option[StatefulSetUpdateStrategy] = None, volumeClaimTemplates: Option[Seq[PersistentVolumeClaim]] = None) extends Product with Serializable
A StatefulSetSpec is the specification of a StatefulSet.
A StatefulSetSpec is the specification of a StatefulSet.
- selector
selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- template
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
- 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.
- 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)
- persistentVolumeClaimRetentionPolicy
persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha. +optional
- 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 isParallelwhich 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.
- updateStrategy
updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
- 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.
- case class StatefulSetStatus(replicas: Int, availableReplicas: Option[Int] = None, collisionCount: Option[Int] = None, conditions: Option[Seq[StatefulSetCondition]] = None, currentReplicas: Option[Int] = None, currentRevision: Option[String] = None, observedGeneration: Option[Long] = None, readyReplicas: Option[Int] = None, updateRevision: Option[String] = None, updatedReplicas: Option[Int] = None) extends Product with Serializable
StatefulSetStatus represents the current state of a StatefulSet.
StatefulSetStatus represents the current state of a StatefulSet.
- replicas
replicas is the number of Pods created by the StatefulSet controller.
- availableReplicas
Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset
- collisionCount
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
- conditions
Represents the latest available observations of a statefulset's current state.
- currentReplicas
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
- currentRevision
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
- observedGeneration
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
- readyReplicas
readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.
- updateRevision
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
- updatedReplicas
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
- case class StatefulSetUpdateStrategy(rollingUpdate: Option[RollingUpdateStatefulSetStrategy] = None, type: Option[String] = None) extends Product with Serializable
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates.
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
- rollingUpdate
RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
Value Members
- object ControllerRevision extends Serializable
- object ControllerRevisionList extends Serializable
- object DaemonSet extends Serializable
- object DaemonSetCondition extends Serializable
- object DaemonSetList extends Serializable
- object DaemonSetSpec extends Serializable
- object DaemonSetStatus extends Serializable
- object DaemonSetUpdateStrategy extends Serializable
- object Deployment extends Serializable
- object DeploymentCondition extends Serializable
- object DeploymentList extends Serializable
- object DeploymentSpec extends Serializable
- object DeploymentStatus extends Serializable
- object DeploymentStrategy extends Serializable
- object ReplicaSet extends Serializable
- object ReplicaSetCondition extends Serializable
- object ReplicaSetList extends Serializable
- object ReplicaSetSpec extends Serializable
- object ReplicaSetStatus extends Serializable
- object RollingUpdateDaemonSet extends Serializable
- object RollingUpdateDeployment extends Serializable
- object RollingUpdateStatefulSetStrategy extends Serializable
- object StatefulSet extends Serializable
- object StatefulSetCondition extends Serializable
- object StatefulSetList extends Serializable
- object StatefulSetPersistentVolumeClaimRetentionPolicy extends Serializable
- object StatefulSetSpec extends Serializable
- object StatefulSetStatus extends Serializable
- object StatefulSetUpdateStrategy extends Serializable