Skip to content

apps.v1.deploymentConfigSpec

"DeploymentConfigSpec represents the desired state of the deployment."

Index

Fields

fn withMinReadySeconds

withMinReadySeconds(minReadySeconds)

"MinReadySeconds is the 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)"

fn withPaused

withPaused(paused)

"Paused indicates that the deployment config is paused resulting in no new deployments on template changes or changes in the template caused by other triggers."

fn withReplicas

withReplicas(replicas)

"Replicas is the number of desired replicas."

fn withRevisionHistoryLimit

withRevisionHistoryLimit(revisionHistoryLimit)

"RevisionHistoryLimit is the number of old ReplicationControllers to retain to allow for rollbacks. This field is a pointer to allow for differentiation between an explicit zero and not specified. Defaults to 10. (This only applies to DeploymentConfigs created via the new group API resource, not the legacy resource.)"

fn withSelector

withSelector(selector)

"Selector is a label query over pods that should match the Replicas count."

fn withSelectorMixin

withSelectorMixin(selector)

"Selector is a label query over pods that should match the Replicas count."

Note: This function appends passed data to existing values

fn withTest

withTest(test)

"Test ensures that this deployment config will have zero replicas except while a deployment is running. This allows the deployment config to be used as a continuous deployment test - triggering on images, running the deployment, and then succeeding or failing. Post strategy hooks and After actions can be used to integrate successful deployment with an action."

fn withTriggers

withTriggers(triggers)

"Triggers determine how updates to a DeploymentConfig result in new deployments. If no triggers are defined, a new deployment can only occur as a result of an explicit client update to the DeploymentConfig with a new LatestVersion. If null, defaults to having a config change trigger."

fn withTriggersMixin

withTriggersMixin(triggers)

"Triggers determine how updates to a DeploymentConfig result in new deployments. If no triggers are defined, a new deployment can only occur as a result of an explicit client update to the DeploymentConfig with a new LatestVersion. If null, defaults to having a config change trigger."

Note: This function appends passed data to existing values

obj strategy

"DeploymentStrategy describes how to perform a deployment."

fn strategy.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 strategy.withAnnotations

withAnnotations(annotations)

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

fn strategy.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 strategy.withLabels

withLabels(labels)

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

fn strategy.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 strategy.withType

withType(type)

"Type is the name of a deployment strategy."

obj strategy.customParams

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

fn strategy.customParams.withCommand

withCommand(command)

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

fn strategy.customParams.withCommandMixin

withCommandMixin(command)

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

Note: This function appends passed data to existing values

fn strategy.customParams.withEnvironment

withEnvironment(environment)

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

fn strategy.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 strategy.customParams.withImage

withImage(image)

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

obj strategy.recreateParams

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

fn strategy.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 strategy.recreateParams.mid

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

fn strategy.recreateParams.mid.withFailurePolicy

withFailurePolicy(failurePolicy)

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

fn strategy.recreateParams.mid.withTagImages

withTagImages(tagImages)

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

fn strategy.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 strategy.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 strategy.recreateParams.mid.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn strategy.recreateParams.mid.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn strategy.recreateParams.mid.execNewPod.withContainerName

withContainerName(containerName)

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

fn strategy.recreateParams.mid.execNewPod.withEnv

withEnv(env)

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

fn strategy.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 strategy.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 strategy.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 strategy.recreateParams.post

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

fn strategy.recreateParams.post.withFailurePolicy

withFailurePolicy(failurePolicy)

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

fn strategy.recreateParams.post.withTagImages

withTagImages(tagImages)

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

fn strategy.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 strategy.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 strategy.recreateParams.post.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn strategy.recreateParams.post.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn strategy.recreateParams.post.execNewPod.withContainerName

withContainerName(containerName)

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

fn strategy.recreateParams.post.execNewPod.withEnv

withEnv(env)

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

fn strategy.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 strategy.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 strategy.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 strategy.recreateParams.pre

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

fn strategy.recreateParams.pre.withFailurePolicy

withFailurePolicy(failurePolicy)

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

fn strategy.recreateParams.pre.withTagImages

withTagImages(tagImages)

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

fn strategy.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 strategy.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 strategy.recreateParams.pre.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn strategy.recreateParams.pre.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn strategy.recreateParams.pre.execNewPod.withContainerName

withContainerName(containerName)

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

fn strategy.recreateParams.pre.execNewPod.withEnv

withEnv(env)

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

fn strategy.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 strategy.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 strategy.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 strategy.resources

"ResourceRequirements describes the compute resource requirements."

fn strategy.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 strategy.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 strategy.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 strategy.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 strategy.rollingParams

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

fn strategy.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 strategy.rollingParams.withMaxSurge

withMaxSurge(maxSurge)

fn strategy.rollingParams.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

fn strategy.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 strategy.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 strategy.rollingParams.post

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

fn strategy.rollingParams.post.withFailurePolicy

withFailurePolicy(failurePolicy)

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

fn strategy.rollingParams.post.withTagImages

withTagImages(tagImages)

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

fn strategy.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 strategy.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 strategy.rollingParams.post.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn strategy.rollingParams.post.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn strategy.rollingParams.post.execNewPod.withContainerName

withContainerName(containerName)

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

fn strategy.rollingParams.post.execNewPod.withEnv

withEnv(env)

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

fn strategy.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 strategy.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 strategy.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 strategy.rollingParams.pre

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

fn strategy.rollingParams.pre.withFailurePolicy

withFailurePolicy(failurePolicy)

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

fn strategy.rollingParams.pre.withTagImages

withTagImages(tagImages)

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

fn strategy.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 strategy.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 strategy.rollingParams.pre.execNewPod.withCommand

withCommand(command)

"Command is the action command and its arguments."

fn strategy.rollingParams.pre.execNewPod.withCommandMixin

withCommandMixin(command)

"Command is the action command and its arguments."

Note: This function appends passed data to existing values

fn strategy.rollingParams.pre.execNewPod.withContainerName

withContainerName(containerName)

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

fn strategy.rollingParams.pre.execNewPod.withEnv

withEnv(env)

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

fn strategy.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 strategy.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 strategy.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

obj template

"PodTemplateSpec describes the data a pod should have when created from a template"

obj template.metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn template.metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn template.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn template.metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn template.metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

fn template.metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn template.metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

fn template.metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."

fn template.metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."

Note: This function appends passed data to existing values

fn template.metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency"

fn template.metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn template.metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn template.metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn template.metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn template.metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn template.metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn template.metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn template.metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only."

fn template.metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj template.metadata.initializers

"Initializers tracks the progress of initialization."

fn template.metadata.initializers.withPending

withPending(pending)

"Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients."

fn template.metadata.initializers.withPendingMixin

withPendingMixin(pending)

"Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients."

Note: This function appends passed data to existing values

obj template.metadata.initializers.result

"Status is a return value for calls that don't return other objects."

fn template.metadata.initializers.result.withApiVersion

withApiVersion(apiVersion)

"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"

fn template.metadata.initializers.result.withCode

withCode(code)

"Suggested HTTP return code for this status, 0 if not set."

fn template.metadata.initializers.result.withKind

withKind(kind)

"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"

fn template.metadata.initializers.result.withMessage

withMessage(message)

"A human-readable description of the status of this operation."

fn template.metadata.initializers.result.withMetadata

withMetadata(metadata)

"Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"

fn template.metadata.initializers.result.withReason

withReason(reason)

"A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it."

obj template.metadata.initializers.result.details

"StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined."

fn template.metadata.initializers.result.details.withCauses

withCauses(causes)

"The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes."

fn template.metadata.initializers.result.details.withCausesMixin

withCausesMixin(causes)

"The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes."

Note: This function appends passed data to existing values

fn template.metadata.initializers.result.details.withGroup

withGroup(group)

"The group attribute of the resource associated with the status StatusReason."

fn template.metadata.initializers.result.details.withKind

withKind(kind)

"The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"

fn template.metadata.initializers.result.details.withName

withName(name)

"The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)."

fn template.metadata.initializers.result.details.withRetryAfterSeconds

withRetryAfterSeconds(retryAfterSeconds)

"If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action."

fn template.metadata.initializers.result.details.withUid

withUid(uid)

"UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj template.spec

"PodSpec is a description of a pod."

fn template.spec.withActiveDeadlineSeconds

withActiveDeadlineSeconds(activeDeadlineSeconds)

"Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer."

fn template.spec.withAutomountServiceAccountToken

withAutomountServiceAccountToken(automountServiceAccountToken)

"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted."

fn template.spec.withContainers

withContainers(containers)

"List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated."

fn template.spec.withContainersMixin

withContainersMixin(containers)

"List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated."

Note: This function appends passed data to existing values

fn template.spec.withDnsPolicy

withDnsPolicy(dnsPolicy)

"Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'."

fn template.spec.withHostAliases

withHostAliases(hostAliases)

"HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods."

fn template.spec.withHostAliasesMixin

withHostAliasesMixin(hostAliases)

"HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods."

Note: This function appends passed data to existing values

fn template.spec.withHostIPC

withHostIPC(hostIPC)

"Use the host's ipc namespace. Optional: Default to false."

fn template.spec.withHostNetwork

withHostNetwork(hostNetwork)

"Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false."

fn template.spec.withHostPID

withHostPID(hostPID)

"Use the host's pid namespace. Optional: Default to false."

fn template.spec.withHostname

withHostname(hostname)

"Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value."

fn template.spec.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod"

fn template.spec.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod"

Note: This function appends passed data to existing values

fn template.spec.withInitContainers

withInitContainers(initContainers)

"List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/"

fn template.spec.withInitContainersMixin

withInitContainersMixin(initContainers)

"List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/"

Note: This function appends passed data to existing values

fn template.spec.withNodeName

withNodeName(nodeName)

"NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements."

fn template.spec.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

fn template.spec.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

Note: This function appends passed data to existing values

fn template.spec.withPriority

withPriority(priority)

"The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority."

fn template.spec.withPriorityClassName

withPriorityClassName(priorityClassName)

"If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default."

fn template.spec.withReadinessGates

withReadinessGates(readinessGates)

"If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md"

fn template.spec.withReadinessGatesMixin

withReadinessGatesMixin(readinessGates)

"If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md"

Note: This function appends passed data to existing values

fn template.spec.withRestartPolicy

withRestartPolicy(restartPolicy)

"Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy"

fn template.spec.withSchedulerName

withSchedulerName(schedulerName)

"If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler."

fn template.spec.withServiceAccount

withServiceAccount(serviceAccount)

"DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead."

fn template.spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/"

fn template.spec.withShareProcessNamespace

withShareProcessNamespace(shareProcessNamespace)

"Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. This field is alpha-level and is honored only by servers that enable the PodShareProcessNamespace feature."

fn template.spec.withSubdomain

withSubdomain(subdomain)

"If specified, the fully qualified Pod hostname will be \"...svc.\". If not specified, the pod will not have a domainname at all."

fn template.spec.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds."

fn template.spec.withTolerations

withTolerations(tolerations)

"If specified, the pod's tolerations."

fn template.spec.withTolerationsMixin

withTolerationsMixin(tolerations)

"If specified, the pod's tolerations."

Note: This function appends passed data to existing values

fn template.spec.withVolumes

withVolumes(volumes)

"List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes"

fn template.spec.withVolumesMixin

withVolumesMixin(volumes)

"List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes"

Note: This function appends passed data to existing values

obj template.spec.affinity

"Affinity is a group of affinity scheduling rules."

obj template.spec.affinity.nodeAffinity

"Node affinity is a group of node affinity scheduling rules."

fn template.spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn template.spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

obj template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms."

fn template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

fn template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

Note: This function appends passed data to existing values

obj template.spec.affinity.podAffinity

"Pod affinity is a group of inter pod affinity scheduling rules."

fn template.spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn template.spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn template.spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn template.spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj template.spec.affinity.podAntiAffinity

"Pod anti affinity is a group of inter pod anti affinity scheduling rules."

fn template.spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn template.spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn template.spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn template.spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj template.spec.dnsConfig

"PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy."

fn template.spec.dnsConfig.withNameservers

withNameservers(nameservers)

"A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed."

fn template.spec.dnsConfig.withNameserversMixin

withNameserversMixin(nameservers)

"A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed."

Note: This function appends passed data to existing values

fn template.spec.dnsConfig.withOptions

withOptions(options)

"A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy."

fn template.spec.dnsConfig.withOptionsMixin

withOptionsMixin(options)

"A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy."

Note: This function appends passed data to existing values

fn template.spec.dnsConfig.withSearches

withSearches(searches)

"A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed."

fn template.spec.dnsConfig.withSearchesMixin

withSearchesMixin(searches)

"A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed."

Note: This function appends passed data to existing values

obj template.spec.securityContext

"PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext."

fn template.spec.securityContext.withFsGroup

withFsGroup(fsGroup)

"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume."

fn template.spec.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."

fn template.spec.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn template.spec.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."

fn template.spec.securityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."

fn template.spec.securityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container."

Note: This function appends passed data to existing values

fn template.spec.securityContext.withSysctls

withSysctls(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch."

fn template.spec.securityContext.withSysctlsMixin

withSysctlsMixin(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch."

Note: This function appends passed data to existing values

obj template.spec.securityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn template.spec.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn template.spec.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn template.spec.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn template.spec.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."