Skip to content

apps.v1.deploymentStrategy

"DeploymentStrategy describes how to perform a deployment."

Index

Fields

fn withActiveDeadlineSeconds

withActiveDeadlineSeconds(activeDeadlineSeconds)

"ActiveDeadlineSeconds is the duration in seconds that the deployer pods for this deployment config may be active on a node before the system actively tries to terminate them."

fn withAnnotations

withAnnotations(annotations)

"Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods."

fn withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods."

Note: This function appends passed data to existing values

fn withLabels

withLabels(labels)

"Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods."

fn withLabelsMixin

withLabelsMixin(labels)

"Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods."

Note: This function appends passed data to existing values

fn withType

withType(type)

"Type is the name of a deployment strategy."

obj customParams

"CustomDeploymentStrategyParams are the input to the Custom deployment strategy."

fn customParams.withCommand

withCommand(command)

"Command is optional and overrides CMD in the container Image."

fn customParams.withCommandMixin

withCommandMixin(command)

"Command is optional and overrides CMD in the container Image."

Note: This function appends passed data to existing values

fn customParams.withEnvironment

withEnvironment(environment)

"Environment holds the environment which will be given to the container for Image."

fn customParams.withEnvironmentMixin

withEnvironmentMixin(environment)

"Environment holds the environment which will be given to the container for Image."

Note: This function appends passed data to existing values

fn customParams.withImage

withImage(image)

"Image specifies a container image which can carry out a deployment."

obj recreateParams

"RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy."

fn recreateParams.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used."

obj recreateParams.mid

"LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time."

fn recreateParams.mid.withFailurePolicy

withFailurePolicy(failurePolicy)

"FailurePolicy specifies what action to take if the hook fails."

fn recreateParams.mid.withTagImages

withTagImages(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

fn recreateParams.mid.withTagImagesMixin

withTagImagesMixin(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

Note: This function appends passed data to existing values

obj recreateParams.mid.execNewPod

"ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template."

fn recreateParams.mid.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn recreateParams.mid.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn recreateParams.mid.execNewPod.withContainerName

withContainerName(containerName)

"ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container."

fn recreateParams.mid.execNewPod.withEnv

withEnv(env)

"Env is a set of environment variables to supply to the hook pod's container."

fn recreateParams.mid.execNewPod.withEnvMixin

withEnvMixin(env)

"Env is a set of environment variables to supply to the hook pod's container."

Note: This function appends passed data to existing values

fn recreateParams.mid.execNewPod.withVolumes

withVolumes(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

fn recreateParams.mid.execNewPod.withVolumesMixin

withVolumesMixin(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

Note: This function appends passed data to existing values

obj recreateParams.post

"LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time."

fn recreateParams.post.withFailurePolicy

withFailurePolicy(failurePolicy)

"FailurePolicy specifies what action to take if the hook fails."

fn recreateParams.post.withTagImages

withTagImages(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

fn recreateParams.post.withTagImagesMixin

withTagImagesMixin(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

Note: This function appends passed data to existing values

obj recreateParams.post.execNewPod

"ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template."

fn recreateParams.post.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn recreateParams.post.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn recreateParams.post.execNewPod.withContainerName

withContainerName(containerName)

"ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container."

fn recreateParams.post.execNewPod.withEnv

withEnv(env)

"Env is a set of environment variables to supply to the hook pod's container."

fn recreateParams.post.execNewPod.withEnvMixin

withEnvMixin(env)

"Env is a set of environment variables to supply to the hook pod's container."

Note: This function appends passed data to existing values

fn recreateParams.post.execNewPod.withVolumes

withVolumes(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

fn recreateParams.post.execNewPod.withVolumesMixin

withVolumesMixin(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

Note: This function appends passed data to existing values

obj recreateParams.pre

"LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time."

fn recreateParams.pre.withFailurePolicy

withFailurePolicy(failurePolicy)

"FailurePolicy specifies what action to take if the hook fails."

fn recreateParams.pre.withTagImages

withTagImages(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

fn recreateParams.pre.withTagImagesMixin

withTagImagesMixin(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

Note: This function appends passed data to existing values

obj recreateParams.pre.execNewPod

"ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template."

fn recreateParams.pre.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn recreateParams.pre.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn recreateParams.pre.execNewPod.withContainerName

withContainerName(containerName)

"ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container."

fn recreateParams.pre.execNewPod.withEnv

withEnv(env)

"Env is a set of environment variables to supply to the hook pod's container."

fn recreateParams.pre.execNewPod.withEnvMixin

withEnvMixin(env)

"Env is a set of environment variables to supply to the hook pod's container."

Note: This function appends passed data to existing values

fn recreateParams.pre.execNewPod.withVolumes

withVolumes(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

fn recreateParams.pre.execNewPod.withVolumesMixin

withVolumesMixin(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

Note: This function appends passed data to existing values

obj resources

"ResourceRequirements describes the compute resource requirements."

fn resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

fn resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

fn resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"

Note: This function appends passed data to existing values

obj rollingParams

"RollingDeploymentStrategyParams are the input to the Rolling deployment strategy."

fn rollingParams.withIntervalSeconds

withIntervalSeconds(intervalSeconds)

"IntervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used."

fn rollingParams.withMaxSurge

withMaxSurge(maxSurge)

fn rollingParams.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

fn rollingParams.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used."

fn rollingParams.withUpdatePeriodSeconds

withUpdatePeriodSeconds(updatePeriodSeconds)

"UpdatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used."

obj rollingParams.post

"LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time."

fn rollingParams.post.withFailurePolicy

withFailurePolicy(failurePolicy)

"FailurePolicy specifies what action to take if the hook fails."

fn rollingParams.post.withTagImages

withTagImages(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

fn rollingParams.post.withTagImagesMixin

withTagImagesMixin(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

Note: This function appends passed data to existing values

obj rollingParams.post.execNewPod

"ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template."

fn rollingParams.post.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn rollingParams.post.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn rollingParams.post.execNewPod.withContainerName

withContainerName(containerName)

"ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container."

fn rollingParams.post.execNewPod.withEnv

withEnv(env)

"Env is a set of environment variables to supply to the hook pod's container."

fn rollingParams.post.execNewPod.withEnvMixin

withEnvMixin(env)

"Env is a set of environment variables to supply to the hook pod's container."

Note: This function appends passed data to existing values

fn rollingParams.post.execNewPod.withVolumes

withVolumes(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

fn rollingParams.post.execNewPod.withVolumesMixin

withVolumesMixin(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

Note: This function appends passed data to existing values

obj rollingParams.pre

"LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time."

fn rollingParams.pre.withFailurePolicy

withFailurePolicy(failurePolicy)

"FailurePolicy specifies what action to take if the hook fails."

fn rollingParams.pre.withTagImages

withTagImages(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

fn rollingParams.pre.withTagImagesMixin

withTagImagesMixin(tagImages)

"TagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag."

Note: This function appends passed data to existing values

obj rollingParams.pre.execNewPod

"ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template."

fn rollingParams.pre.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn rollingParams.pre.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn rollingParams.pre.execNewPod.withContainerName

withContainerName(containerName)

"ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container."

fn rollingParams.pre.execNewPod.withEnv

withEnv(env)

"Env is a set of environment variables to supply to the hook pod's container."

fn rollingParams.pre.execNewPod.withEnvMixin

withEnvMixin(env)

"Env is a set of environment variables to supply to the hook pod's container."

Note: This function appends passed data to existing values

fn rollingParams.pre.execNewPod.withVolumes

withVolumes(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

fn rollingParams.pre.execNewPod.withVolumesMixin

withVolumesMixin(volumes)

"Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied."

Note: This function appends passed data to existing values