zio-k8s-client/com.coralogix.zio.k8s.model.apps.v1

com.coralogix.zio.k8s.model.apps.v1

package com.coralogix.zio.k8s.model.apps.v1

Type members

Classlikes

case
class ControllerRevision(data: Optional[RawExtension], metadata: Optional[ObjectMeta], revision: Long)

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.

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.

Value Params
revision

Revision indicates the revision of the state represented by Data.

Companion
object
object ControllerRevision extends ControllerRevisionFields
Companion
class
class ControllerRevisionFields(_prefix: Chunk[String])
case
class DaemonSet(metadata: Optional[ObjectMeta], spec: Optional[DaemonSetSpec], status: Optional[DaemonSetStatus])

DaemonSet represents the configuration of a daemon set.

DaemonSet represents the configuration of a daemon set.

Companion
object
object DaemonSet extends DaemonSetFields
Companion
class
case
class DaemonSetCondition(lastTransitionTime: Optional[Time], message: Optional[String], reason: Optional[String], status: String, `type`: String)

DaemonSetCondition describes the state of a DaemonSet at a certain point.

DaemonSetCondition describes the state of a DaemonSet at a certain point.

Value Params
message

A human readable message indicating details about the transition.

reason

The reason for the condition's last transition.

status

Status of the condition, one of True, False, Unknown.

type

Type of DaemonSet condition.

Companion
object
object DaemonSetCondition extends DaemonSetConditionFields
Companion
class
class DaemonSetConditionFields(_prefix: Chunk[String])
class DaemonSetFields(_prefix: Chunk[String])
case
class DaemonSetSpec(minReadySeconds: Optional[Int], revisionHistoryLimit: Optional[Int], selector: LabelSelector, template: PodTemplateSpec, updateStrategy: Optional[DaemonSetUpdateStrategy])

DaemonSetSpec is the specification of a daemon set.

DaemonSetSpec is the specification of a daemon set.

Value Params
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.

Companion
object
object DaemonSetSpec extends DaemonSetSpecFields
Companion
class
class DaemonSetSpecFields(_prefix: Chunk[String])
case
class DaemonSetStatus(collisionCount: Optional[Int], conditions: Optional[Vector[DaemonSetCondition]], currentNumberScheduled: Int, desiredNumberScheduled: Int, numberAvailable: Optional[Int], numberMisscheduled: Int, numberReady: Int, numberUnavailable: Optional[Int], observedGeneration: Optional[Long], updatedNumberScheduled: Optional[Int])

DaemonSetStatus represents the current status of a daemon set.

DaemonSetStatus represents the current status of a daemon set.

Value Params
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.

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/

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/

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)

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/

numberReady

The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

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

Companion
object
object DaemonSetStatus extends DaemonSetStatusFields
Companion
class
class DaemonSetStatusFields(_prefix: Chunk[String])
case
class DaemonSetUpdateStrategy(rollingUpdate: Optional[RollingUpdateDaemonSet], `type`: Optional[String])

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.

Value Params
type

Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.

Companion
object
object DaemonSetUpdateStrategy extends DaemonSetUpdateStrategyFields
Companion
class
class DaemonSetUpdateStrategyFields(_prefix: Chunk[String])
case
class Deployment(metadata: Optional[ObjectMeta], spec: Optional[DeploymentSpec], status: Optional[DeploymentStatus])

Deployment enables declarative updates for Pods and ReplicaSets.

Deployment enables declarative updates for Pods and ReplicaSets.

Companion
object
object Deployment extends DeploymentFields
Companion
class
case
class DeploymentCondition(lastTransitionTime: Optional[Time], lastUpdateTime: Optional[Time], message: Optional[String], reason: Optional[String], status: String, `type`: String)

DeploymentCondition describes the state of a deployment at a certain point.

DeploymentCondition describes the state of a deployment at a certain point.

Value Params
message

A human readable message indicating details about the transition.

reason

The reason for the condition's last transition.

status

Status of the condition, one of True, False, Unknown.

type

Type of deployment condition.

Companion
object
object DeploymentCondition extends DeploymentConditionFields
Companion
class
class DeploymentConditionFields(_prefix: Chunk[String])
class DeploymentFields(_prefix: Chunk[String])
case
class DeploymentSpec(minReadySeconds: Optional[Int], paused: Optional[Boolean], progressDeadlineSeconds: Optional[Int], replicas: Optional[Int], revisionHistoryLimit: Optional[Int], selector: LabelSelector, strategy: Optional[DeploymentStrategy], template: PodTemplateSpec)

DeploymentSpec is the specification of the desired behavior of the Deployment.

DeploymentSpec is the specification of the desired behavior of the Deployment.

Value Params
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.

Companion
object
object DeploymentSpec extends DeploymentSpecFields
Companion
class
class DeploymentSpecFields(_prefix: Chunk[String])
case
class DeploymentStatus(availableReplicas: Optional[Int], collisionCount: Optional[Int], conditions: Optional[Vector[DeploymentCondition]], observedGeneration: Optional[Long], readyReplicas: Optional[Int], replicas: Optional[Int], unavailableReplicas: Optional[Int], updatedReplicas: Optional[Int])

DeploymentStatus is the most recently observed status of the Deployment.

DeploymentStatus is the most recently observed status of the Deployment.

Value Params
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

Total number of ready pods targeted by this deployment.

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.

Companion
object
object DeploymentStatus extends DeploymentStatusFields
Companion
class
class DeploymentStatusFields(_prefix: Chunk[String])
case
class DeploymentStrategy(rollingUpdate: Optional[RollingUpdateDeployment], `type`: Optional[String])

DeploymentStrategy describes how to replace existing pods with new ones.

DeploymentStrategy describes how to replace existing pods with new ones.

Value Params
type

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

Companion
object
object DeploymentStrategy extends DeploymentStrategyFields
Companion
class
class DeploymentStrategyFields(_prefix: Chunk[String])
case
class ReplicaSet(metadata: Optional[ObjectMeta], spec: Optional[ReplicaSetSpec], status: Optional[ReplicaSetStatus])

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.

Companion
object
object ReplicaSet extends ReplicaSetFields
Companion
class
case
class ReplicaSetCondition(lastTransitionTime: Optional[Time], message: Optional[String], reason: Optional[String], status: String, `type`: String)

ReplicaSetCondition describes the state of a replica set at a certain point.

ReplicaSetCondition describes the state of a replica set at a certain point.

Value Params
message

A human readable message indicating details about the transition.

reason

The reason for the condition's last transition.

status

Status of the condition, one of True, False, Unknown.

type

Type of replica set condition.

Companion
object
object ReplicaSetCondition extends ReplicaSetConditionFields
Companion
class
class ReplicaSetConditionFields(_prefix: Chunk[String])
class ReplicaSetFields(_prefix: Chunk[String])
case
class ReplicaSetSpec(minReadySeconds: Optional[Int], replicas: Optional[Int], selector: LabelSelector, template: Optional[PodTemplateSpec])

ReplicaSetSpec is the specification of a ReplicaSet.

ReplicaSetSpec is the specification of a ReplicaSet.

Value Params
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

Companion
object
object ReplicaSetSpec extends ReplicaSetSpecFields
Companion
class
class ReplicaSetSpecFields(_prefix: Chunk[String])
case
class ReplicaSetStatus(availableReplicas: Optional[Int], conditions: Optional[Vector[ReplicaSetCondition]], fullyLabeledReplicas: Optional[Int], observedGeneration: Optional[Long], readyReplicas: Optional[Int], replicas: Int)

ReplicaSetStatus represents the current status of a ReplicaSet.

ReplicaSetStatus represents the current status of a ReplicaSet.

Value Params
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

The number of ready replicas for this replica set.

replicas

Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

Companion
object
object ReplicaSetStatus extends ReplicaSetStatusFields
Companion
class
class ReplicaSetStatusFields(_prefix: Chunk[String])
case
class RollingUpdateDaemonSet(maxSurge: Optional[IntOrString], maxUnavailable: Optional[IntOrString])

Spec to control the desired behavior of daemon set rolling update.

Spec to control the desired behavior of daemon set rolling update.

Companion
object
object RollingUpdateDaemonSet extends RollingUpdateDaemonSetFields
Companion
class
class RollingUpdateDaemonSetFields(_prefix: Chunk[String])
case
class RollingUpdateDeployment(maxSurge: Optional[IntOrString], maxUnavailable: Optional[IntOrString])

Spec to control the desired behavior of rolling update.

Spec to control the desired behavior of rolling update.

Companion
object
object RollingUpdateDeployment extends RollingUpdateDeploymentFields
Companion
class
class RollingUpdateDeploymentFields(_prefix: Chunk[String])
case
class RollingUpdateStatefulSetStrategy(partition: Optional[Int])

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

Value Params
partition

Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.

Companion
object
object RollingUpdateStatefulSetStrategy extends RollingUpdateStatefulSetStrategyFields
Companion
class
class RollingUpdateStatefulSetStrategyFields(_prefix: Chunk[String])
case
class StatefulSet(metadata: Optional[ObjectMeta], spec: Optional[StatefulSetSpec], status: Optional[StatefulSetStatus])

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

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.
Companion
object
object StatefulSet extends StatefulSetFields
Companion
class
case
class StatefulSetCondition(lastTransitionTime: Optional[Time], message: Optional[String], reason: Optional[String], status: String, `type`: String)

StatefulSetCondition describes the state of a statefulset at a certain point.

StatefulSetCondition describes the state of a statefulset at a certain point.

Value Params
message

A human readable message indicating details about the transition.

reason

The reason for the condition's last transition.

status

Status of the condition, one of True, False, Unknown.

type

Type of statefulset condition.

Companion
object
object StatefulSetCondition extends StatefulSetConditionFields
Companion
class
class StatefulSetConditionFields(_prefix: Chunk[String])
class StatefulSetFields(_prefix: Chunk[String])
case
class StatefulSetSpec(minReadySeconds: Optional[Int], podManagementPolicy: Optional[String], replicas: Optional[Int], revisionHistoryLimit: Optional[Int], selector: LabelSelector, serviceName: String, template: PodTemplateSpec, updateStrategy: Optional[StatefulSetUpdateStrategy], volumeClaimTemplates: Optional[Vector[PersistentVolumeClaim]])

A StatefulSetSpec is the specification of a StatefulSet.

A StatefulSetSpec is the specification of a StatefulSet.

Value Params
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.

Companion
object
object StatefulSetSpec extends StatefulSetSpecFields
Companion
class
class StatefulSetSpecFields(_prefix: Chunk[String])
case
class StatefulSetStatus(availableReplicas: Optional[Int], collisionCount: Optional[Int], conditions: Optional[Vector[StatefulSetCondition]], currentReplicas: Optional[Int], currentRevision: Optional[String], observedGeneration: Optional[Long], readyReplicas: Optional[Int], replicas: Int, updateRevision: Optional[String], updatedReplicas: Optional[Int])

StatefulSetStatus represents the current state of a StatefulSet.

StatefulSetStatus represents the current state of a StatefulSet.

Value Params
availableReplicas

Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset. This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate. Remove omitempty when graduating to beta

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 by the StatefulSet controller that have a Ready Condition.

replicas

replicas is the number of Pods created by the StatefulSet controller.

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.

Companion
object
object StatefulSetStatus extends StatefulSetStatusFields
Companion
class
class StatefulSetStatusFields(_prefix: Chunk[String])
case
class StatefulSetUpdateStrategy(rollingUpdate: Optional[RollingUpdateStatefulSetStrategy], `type`: Optional[String])

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.

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.

Value Params
type

Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.

Companion
object
object StatefulSetUpdateStrategy extends StatefulSetUpdateStrategyFields
Companion
class
class StatefulSetUpdateStrategyFields(_prefix: Chunk[String])