Fork me on GitHub

Module apps/v1beta1

@pulumi/kubernetes > apps > v1beta1

Index

types/input.ts types/output.ts

function isControllerRevision

isControllerRevision(o: any): boolean

function isControllerRevisionList

isControllerRevisionList(o: any): boolean

function isDeployment

isDeployment(o: any): boolean

function isDeploymentList

isDeploymentList(o: any): boolean

function isDeploymentRollback

isDeploymentRollback(o: any): boolean

function isScale

isScale(o: any): boolean

function isStatefulSet

isStatefulSet(o: any): boolean

function isStatefulSetList

isStatefulSetList(o: any): boolean

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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property data

data: RawExtension;

Data is the serialized representation of the state.

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property revision

revision: number;

Revision indicates the revision of the state represented by Data.

interface ControllerRevisionList

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property items

items: ControllerRevision[];

Items is the list of ControllerRevisions

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

Standard object metadata.

property spec

spec: DeploymentSpec;

Specification of the desired behavior of the Deployment.

property status

status: DeploymentStatus;

Most recently observed status of the Deployment.

interface DeploymentCondition

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

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property lastUpdateTime

lastUpdateTime: string;

The last time this condition was updated.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

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

property type

type: string;

Type of deployment condition.

interface DeploymentList

DeploymentList is a list of Deployments.

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property items

items: Deployment[];

Items is the list of Deployments.

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

Standard list metadata.

interface DeploymentRollback

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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property name

name: string;

Required: This must match the Name of a deployment.

property rollbackTo

rollbackTo: RollbackConfig;

The config of this deployment rollback.

property updatedAnnotations

updatedAnnotations: { ... };

The annotations to be updated to a deployment

interface DeploymentSpec

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

property minReadySeconds

minReadySeconds: number;

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)

property paused

paused: boolean;

Indicates that the deployment is paused.

property progressDeadlineSeconds

progressDeadlineSeconds: number;

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.

property replicas

replicas: number;

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

property revisionHistoryLimit

revisionHistoryLimit: number;

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.

property rollbackTo

rollbackTo: RollbackConfig;

DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.

property selector

selector: LabelSelector;

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

property strategy

strategy: DeploymentStrategy;

The deployment strategy to use to replace existing pods with new ones.

property template

template: PodTemplateSpec;

Template describes the pods that will be created.

interface DeploymentStatus

DeploymentStatus is the most recently observed status of the Deployment.

property availableReplicas

availableReplicas: number;

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

property collisionCount

collisionCount: number;

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.

property conditions

conditions: DeploymentCondition[];

Represents the latest available observations of a deployment’s current state.

property observedGeneration

observedGeneration: number;

The generation observed by the deployment controller.

property readyReplicas

readyReplicas: number;

Total number of ready pods targeted by this deployment.

property replicas

replicas: number;

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

property unavailableReplicas

unavailableReplicas: number;

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.

property updatedReplicas

updatedReplicas: number;

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

interface DeploymentStrategy

DeploymentStrategy describes how to replace existing pods with new ones.

property rollingUpdate

rollingUpdate: RollingUpdateDeployment;

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

property type

type: string;

Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate.

interface RollbackConfig

DEPRECATED.

property revision

revision: number;

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

interface RollingUpdateDeployment

Spec to control the desired behavior of rolling update.

property maxSurge

maxSurge: number | string;

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.

property maxUnavailable

maxUnavailable: number | string;

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.

interface RollingUpdateStatefulSetStrategy

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

property partition

partition: number;

Partition indicates the ordinal at which the StatefulSet should be partitioned.

interface Scale

Scale represents a scaling request for a resource.

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.

property spec

spec: ScaleSpec;

defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.

property status

status: ScaleStatus;

current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.

interface ScaleSpec

ScaleSpec describes the attributes of a scale subresource

property replicas

replicas: number;

desired number of instances for the scaled object.

interface ScaleStatus

ScaleStatus represents the current status of a scale subresource.

property replicas

replicas: number;

actual number of observed instances of the scaled object.

property selector

selector: { ... };

label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

property targetSelector

targetSelector: string;

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

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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

property spec

spec: StatefulSetSpec;

Spec defines the desired identities of pods in this set.

property status

status: StatefulSetStatus;

Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

interface StatefulSetCondition

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

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

A human readable message indicating details about the transition.

property reason

reason: string;

The reason for the condition’s last transition.

property status

status: string;

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

property type

type: string;

Type of statefulset condition.

interface StatefulSetList

StatefulSetList is a collection of StatefulSets.

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property items

items: StatefulSet[];

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

interface StatefulSetSpec

A StatefulSetSpec is the specification of a StatefulSet.

property podManagementPolicy

podManagementPolicy: string;

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.

property replicas

replicas: number;

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.

property revisionHistoryLimit

revisionHistoryLimit: number;

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.

property selector

selector: LabelSelector;

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

property serviceName

serviceName: string;

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.

property template

template: PodTemplateSpec;

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.

property updateStrategy

updateStrategy: StatefulSetUpdateStrategy;

updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

property volumeClaimTemplates

volumeClaimTemplates: PersistentVolumeClaim[];

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.

interface StatefulSetStatus

StatefulSetStatus represents the current state of a StatefulSet.

property collisionCount

collisionCount: number;

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.

property conditions

conditions: StatefulSetCondition[];

Represents the latest available observations of a statefulset’s current state.

property currentReplicas

currentReplicas: number;

currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.

property currentRevision

currentRevision: string;

currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).

property observedGeneration

observedGeneration: number;

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.

property readyReplicas

readyReplicas: number;

readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.

property replicas

replicas: number;

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

property updateRevision

updateRevision: string;

updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)

property updatedReplicas

updatedReplicas: number;

updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

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

property rollingUpdate

rollingUpdate: RollingUpdateStatefulSetStrategy;

RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.

property type

type: string;

Type indicates the type of the StatefulSetUpdateStrategy.