org.cdk8s.plus20

Class Deployment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

org.cdk8s.plus20.Resource

org.cdk8s.plus20.Deployment

All Implemented Interfaces:

IPodSpec, IPodTemplate, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.34.0 (build 9b72778)",
           date="2021-09-21T00:27:37.462Z")
 @Stability(value=Stable)
public class Deployment
extends Resource
implements IPodTemplate

A Deployment provides declarative updates for Pods and ReplicaSets.

You describe a desired state in a Deployment, and the Deployment Controller changes the actual state to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments.

Note: Do not manage ReplicaSets owned by a Deployment. Consider opening an issue in the main Kubernetes repository if your use case is not covered below.

Use Case

The following are typical use cases for Deployments:

• Create a Deployment to rollout a ReplicaSet. The ReplicaSet creates Pods in the background. Check the status of the rollout to see if it succeeds or not.
• Declare the new state of the Pods by updating the PodTemplateSpec of the Deployment. A new ReplicaSet is created and the Deployment manages moving the Pods from the old ReplicaSet to the new one at a controlled rate. Each new ReplicaSet updates the revision of the Deployment.
• Rollback to an earlier Deployment revision if the current state of the Deployment is not stable. Each rollback updates the revision of the Deployment.
• Scale up the Deployment to facilitate more load.
• Pause the Deployment to apply multiple fixes to its PodTemplateSpec and then resume it to start a new rollout.
• Use the status of the Deployment as an indicator that a rollout has stuck.
• Clean up older ReplicaSets that you don't need anymore.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Deployment.Builder A fluent builder for Deployment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface org.cdk8s.plus20.IPodTemplate

IPodTemplate.Jsii$Default, IPodTemplate.Jsii$Proxy

Nested classes/interfaces inherited from interface org.cdk8s.plus20.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Deployment(software.constructs.Construct scope, String id)
	Deployment(software.constructs.Construct scope, String id, DeploymentProps props)
protected	Deployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Deployment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Container	addContainer(ContainerProps container) Add a container to the pod.
void	addVolume(Volume volume) Add a volume to the pod.
Service	expose(Number port) Expose a deployment via a service.
Service	expose(Number port, ExposeOptions options) Expose a deployment via a service.
protected org.cdk8s.ApiObject	getApiObject() The underlying cdk8s API object.
List<Container>	getContainers() The containers belonging to the pod.
Map<String,String>	getLabelSelector() The labels this deployment will match against in order to select pods.
org.cdk8s.ApiObjectMetadataDefinition	getPodMetadata() Provides read/write access to the underlying pod metadata of the resource.
Number	getReplicas() Number of desired pods.
RestartPolicy	getRestartPolicy() Restart policy for all containers within the pod.
IServiceAccount	getServiceAccount() The service account used to run this pod.
List<Volume>	getVolumes() The volumes associated with this pod.
void	selectByLabel(String key, String value) Configure a label selector to this deployment.

Methods inherited from class org.cdk8s.plus20.Resource

getMetadata, getName

Methods inherited from class software.constructs.Construct

onPrepare, onSynthesize, onValidate, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Deployment

protected Deployment(software.amazon.jsii.JsiiObjectRef objRef)

Deployment

protected Deployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Deployment

@Stability(value=Stable)
public Deployment(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @Nullable
                                           DeploymentProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Deployment

@Stability(value=Stable)
public Deployment(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addContainer

@Stability(value=Stable)
 @NotNull
public Container addContainer(@NotNull
                                                                 ContainerProps container)

Add a container to the pod.

Specified by:

addContainer in interface IPodSpec

Parameters:

container - This parameter is required.

addVolume

@Stability(value=Stable)
public void addVolume(@NotNull
                                               Volume volume)

Add a volume to the pod.

Specified by:

addVolume in interface IPodSpec

Parameters:

volume - This parameter is required.

expose

@Stability(value=Stable)
 @NotNull
public Service expose(@NotNull
                                                         Number port,
                                                         @Nullable
                                                         ExposeOptions options)

Expose a deployment via a service.

This is equivalent to running kubectl expose deployment <deployment-name>.

Parameters:

port - The port number the service will bind to. This parameter is required.

options - Options to determine details of the service and port exposed.

expose

@Stability(value=Stable)
 @NotNull
public Service expose(@NotNull
                                                         Number port)

Expose a deployment via a service.

This is equivalent to running kubectl expose deployment <deployment-name>.

Parameters:

port - The port number the service will bind to. This parameter is required.

selectByLabel

@Stability(value=Stable)
public void selectByLabel(@NotNull
                                                   String key,
                                                   @NotNull
                                                   String value)

Configure a label selector to this deployment.

Pods that have the label will be selected by deployments configured with this spec.

Parameters:

key - - The label key. This parameter is required.

value - - The label value. This parameter is required.

getApiObject

@Stability(value=Stable)
 @NotNull
protected org.cdk8s.ApiObject getApiObject()

The underlying cdk8s API object.

Specified by:

getApiObject in class Resource

See Also:

base.Resource.apiObject

getContainers

@Stability(value=Stable)
 @NotNull
public List<Container> getContainers()

The containers belonging to the pod.

Use addContainer to add containers.

Specified by:

getContainers in interface IPodSpec

getLabelSelector

@Stability(value=Stable)
 @NotNull
public Map<String,String> getLabelSelector()

The labels this deployment will match against in order to select pods.

Returns a a copy. Use selectByLabel() to add labels.

getPodMetadata

@Stability(value=Stable)
 @NotNull
public org.cdk8s.ApiObjectMetadataDefinition getPodMetadata()

Provides read/write access to the underlying pod metadata of the resource.

Specified by:

getPodMetadata in interface IPodTemplate

getReplicas

@Stability(value=Stable)
 @NotNull
public Number getReplicas()

Number of desired pods.

getVolumes

@Stability(value=Stable)
 @NotNull
public List<Volume> getVolumes()

The volumes associated with this pod.

Use addVolume to add volumes.

Specified by:

getVolumes in interface IPodSpec

getRestartPolicy

@Stability(value=Stable)
 @Nullable
public RestartPolicy getRestartPolicy()

Restart policy for all containers within the pod.

Specified by:

getRestartPolicy in interface IPodSpec

getServiceAccount

@Stability(value=Stable)
 @Nullable
public IServiceAccount getServiceAccount()

The service account used to run this pod.

Specified by:

getServiceAccount in interface IPodSpec