Kubernetes.Api.Apps.V1Beta1

newtype ControllerRevision

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. 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.

Fields:

• _data: Data is the serialized representation of the state.
• metadata: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
• revision: Revision indicates the revision of the state represented by Data.

Constructors

• ControllerRevision { _data :: Maybe RawExtension, metadata :: Maybe ObjectMeta, revision :: Maybe Int }

Instances

• Newtype ControllerRevision _
• Generic ControllerRevision _
• Show ControllerRevision
• Decode ControllerRevision
• Encode ControllerRevision
• Default ControllerRevision

newtype ControllerRevisionList

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

Fields:

• items: Items is the list of ControllerRevisions
• metadata: More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

Constructors

• ControllerRevisionList { items :: Maybe (Array ControllerRevision), metadata :: Maybe ListMeta }

Instances

• Newtype ControllerRevisionList _
• Generic ControllerRevisionList _
• Show ControllerRevisionList
• Decode ControllerRevisionList
• Encode ControllerRevisionList
• Default ControllerRevisionList

newtype Deployment

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

Fields:

• metadata: Standard object metadata.
• spec: Specification of the desired behavior of the Deployment.
• status: Most recently observed status of the Deployment.

Constructors

• Deployment { metadata :: Maybe ObjectMeta, spec :: Maybe DeploymentSpec, status :: Maybe DeploymentStatus }

Instances

• Newtype Deployment _
• Generic Deployment _
• Show Deployment
• Decode Deployment
• Encode Deployment
• Default Deployment

newtype DeploymentCondition

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

Fields:

• _type: Type of deployment condition.
• 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.
• status: Status of the condition, one of True, False, Unknown.

Constructors

• DeploymentCondition { _type :: Maybe String, lastTransitionTime :: Maybe Time, lastUpdateTime :: Maybe Time, message :: Maybe String, reason :: Maybe String, status :: Maybe String }

Instances

• Newtype DeploymentCondition _
• Generic DeploymentCondition _
• Show DeploymentCondition
• Decode DeploymentCondition
• Encode DeploymentCondition
• Default DeploymentCondition

newtype DeploymentList

DeploymentList is a list of Deployments.

Fields:

• items: Items is the list of Deployments.
• metadata: Standard list metadata.

Constructors

• DeploymentList { items :: Maybe (Array Deployment), metadata :: Maybe ListMeta }

Instances

• Newtype DeploymentList _
• Generic DeploymentList _
• Show DeploymentList
• Decode DeploymentList
• Encode DeploymentList
• Default DeploymentList

newtype DeploymentRollback

DEPRECATED. DeploymentRollback stores the information required to rollback a deployment.

Fields:

• name: Required: This must match the Name of a deployment.
• rollbackTo: The config of this deployment rollback.
• updatedAnnotations: The annotations to be updated to a deployment

Constructors

• DeploymentRollback { name :: Maybe String, rollbackTo :: Maybe RollbackConfig, updatedAnnotations :: Maybe (Object String) }

Instances

• Newtype DeploymentRollback _
• Generic DeploymentRollback _
• Show DeploymentRollback
• Decode DeploymentRollback
• Encode DeploymentRollback
• Default DeploymentRollback

newtype DeploymentSpec

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

Fields:

• 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 2.
• rollbackTo: DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.
• selector: Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
• strategy: The deployment strategy to use to replace existing pods with new ones.
• template: Template describes the pods that will be created.

Constructors

• DeploymentSpec { minReadySeconds :: Maybe Int, paused :: Maybe Boolean, progressDeadlineSeconds :: Maybe Int, replicas :: Maybe Int, revisionHistoryLimit :: Maybe Int, rollbackTo :: Maybe RollbackConfig, selector :: Maybe LabelSelector, strategy :: Maybe DeploymentStrategy, template :: Maybe PodTemplateSpec }

Instances

• Newtype DeploymentSpec _
• Generic DeploymentSpec _
• Show DeploymentSpec
• Decode DeploymentSpec
• Encode DeploymentSpec
• Default DeploymentSpec

newtype DeploymentStatus

DeploymentStatus is the most recently observed status of the Deployment.

Fields:

• 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.

Constructors

• DeploymentStatus { availableReplicas :: Maybe Int, collisionCount :: Maybe Int, conditions :: Maybe (Array DeploymentCondition), observedGeneration :: Maybe Int, readyReplicas :: Maybe Int, replicas :: Maybe Int, unavailableReplicas :: Maybe Int, updatedReplicas :: Maybe Int }

Instances

• Newtype DeploymentStatus _
• Generic DeploymentStatus _
• Show DeploymentStatus
• Decode DeploymentStatus
• Encode DeploymentStatus
• Default DeploymentStatus

newtype DeploymentStrategy

DeploymentStrategy describes how to replace existing pods with new ones.

Fields:

• _type: Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
• rollingUpdate: Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

Constructors

• DeploymentStrategy { _type :: Maybe String, rollingUpdate :: Maybe RollingUpdateDeployment }

Instances

• Newtype DeploymentStrategy _
• Generic DeploymentStrategy _
• Show DeploymentStrategy
• Decode DeploymentStrategy
• Encode DeploymentStrategy
• Default DeploymentStrategy

newtype RollbackConfig

DEPRECATED.

Fields:

• revision: The revision to rollback to. If set to 0, rollback to the last revision.

Constructors

• RollbackConfig { revision :: Maybe Int }

Instances

• Newtype RollbackConfig _
• Generic RollbackConfig _
• Show RollbackConfig
• Decode RollbackConfig
• Encode RollbackConfig
• Default RollbackConfig

newtype RollingUpdateDeployment

Spec to control the desired behavior of rolling update.

Fields:

• 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 RC 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 RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 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 RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

Constructors

• RollingUpdateDeployment { maxSurge :: Maybe IntOrString, maxUnavailable :: Maybe IntOrString }

Instances

• Newtype RollingUpdateDeployment _
• Generic RollingUpdateDeployment _
• Show RollingUpdateDeployment
• Decode RollingUpdateDeployment
• Encode RollingUpdateDeployment
• Default RollingUpdateDeployment

newtype RollingUpdateStatefulSetStrategy

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

Fields:

• partition: Partition indicates the ordinal at which the StatefulSet should be partitioned.

Constructors

• RollingUpdateStatefulSetStrategy { partition :: Maybe Int }

Instances

• Newtype RollingUpdateStatefulSetStrategy _
• Generic RollingUpdateStatefulSetStrategy _
• Show RollingUpdateStatefulSetStrategy
• Decode RollingUpdateStatefulSetStrategy
• Encode RollingUpdateStatefulSetStrategy
• Default RollingUpdateStatefulSetStrategy

newtype Scale

Scale represents a scaling request for a resource.

Fields:

• metadata: Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
• spec: defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
• status: current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.

Constructors

• Scale { metadata :: Maybe ObjectMeta, spec :: Maybe ScaleSpec, status :: Maybe ScaleStatus }

Instances

• Newtype Scale _
• Generic Scale _
• Show Scale
• Decode Scale
• Encode Scale
• Default Scale

newtype ScaleSpec

ScaleSpec describes the attributes of a scale subresource

Fields:

• replicas: desired number of instances for the scaled object.

Constructors

• ScaleSpec { replicas :: Maybe Int }

Instances

• Newtype ScaleSpec _
• Generic ScaleSpec _
• Show ScaleSpec
• Decode ScaleSpec
• Encode ScaleSpec
• Default ScaleSpec

newtype ScaleStatus

ScaleStatus represents the current status of a scale subresource.

Fields:

• replicas: actual number of observed instances of the scaled object.
• selector: label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
• targetSelector: label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Constructors

• ScaleStatus { replicas :: Maybe Int, selector :: Maybe (Object String), targetSelector :: Maybe String }

Instances

• Newtype ScaleStatus _
• Generic ScaleStatus _
• Show ScaleStatus
• Decode ScaleStatus
• Encode ScaleStatus
• Default ScaleStatus

newtype StatefulSet

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. 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.

Fields:

• 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.

Constructors

• StatefulSet { metadata :: Maybe ObjectMeta, spec :: Maybe StatefulSetSpec, status :: Maybe StatefulSetStatus }

Instances

• Newtype StatefulSet _
• Generic StatefulSet _
• Show StatefulSet
• Decode StatefulSet
• Encode StatefulSet
• Default StatefulSet

newtype StatefulSetCondition

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

Fields:

• _type: Type of statefulset condition.
• 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.
• status: Status of the condition, one of True, False, Unknown.

Constructors

• StatefulSetCondition { _type :: Maybe String, lastTransitionTime :: Maybe Time, message :: Maybe String, reason :: Maybe String, status :: Maybe String }

Instances

• Newtype StatefulSetCondition _
• Generic StatefulSetCondition _
• Show StatefulSetCondition
• Decode StatefulSetCondition
• Encode StatefulSetCondition
• Default StatefulSetCondition

newtype StatefulSetList

StatefulSetList is a collection of StatefulSets.

Fields:

• items
• metadata

Constructors

• StatefulSetList { items :: Maybe (Array StatefulSet), metadata :: Maybe ListMeta }

Instances

• Newtype StatefulSetList _
• Generic StatefulSetList _
• Show StatefulSetList
• Decode StatefulSetList
• Encode StatefulSetList
• Default StatefulSetList

newtype StatefulSetSpec

A StatefulSetSpec is the specification of a StatefulSet.

Fields:

• 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.
• selector: selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
• 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.
• 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.
• 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.

Constructors

• StatefulSetSpec { podManagementPolicy :: Maybe String, replicas :: Maybe Int, revisionHistoryLimit :: Maybe Int, selector :: Maybe LabelSelector, serviceName :: Maybe String, template :: Maybe PodTemplateSpec, updateStrategy :: Maybe StatefulSetUpdateStrategy, volumeClaimTemplates :: Maybe (Array PersistentVolumeClaim) }

Instances

• Newtype StatefulSetSpec _
• Generic StatefulSetSpec _
• Show StatefulSetSpec
• Decode StatefulSetSpec
• Encode StatefulSetSpec
• Default StatefulSetSpec

newtype StatefulSetStatus

StatefulSetStatus represents the current state of a StatefulSet.

Fields:

• 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.

Constructors

• StatefulSetStatus { collisionCount :: Maybe Int, conditions :: Maybe (Array StatefulSetCondition), currentReplicas :: Maybe Int, currentRevision :: Maybe String, observedGeneration :: Maybe Int, readyReplicas :: Maybe Int, replicas :: Maybe Int, updateRevision :: Maybe String, updatedReplicas :: Maybe Int }

Instances

• Newtype StatefulSetStatus _
• Generic StatefulSetStatus _
• Show StatefulSetStatus
• Decode StatefulSetStatus
• Encode StatefulSetStatus
• Default StatefulSetStatus

newtype StatefulSetUpdateStrategy

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.

Fields:

• _type: Type indicates the type of the StatefulSetUpdateStrategy.
• rollingUpdate: RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.

Constructors

• StatefulSetUpdateStrategy { _type :: Maybe String, rollingUpdate :: Maybe RollingUpdateStatefulSetStrategy }

Instances

• Newtype StatefulSetUpdateStrategy _
• Generic StatefulSetUpdateStrategy _
• Show StatefulSetUpdateStrategy
• Decode StatefulSetUpdateStrategy
• Encode StatefulSetUpdateStrategy
• Default StatefulSetUpdateStrategy

getAPIResources :: Config -> Aff (Either Status APIResourceList)

get available resources