• Русский
  • KamajiControlPlaneTemplate [controlplane.cluster.x-k8s.io/v1alpha1]

    Description
    KamajiControlPlaneTemplate is the Schema for the kamajicontrolplanetemplates API.
    Type
    object

    Specification

    PropertyTypeDescription
    apiVersionstring

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

    kindstring

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

    metadataObjectMeta

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

    specobject

    KamajiControlPlaneTemplateSpec defines the desired state of KamajiControlPlaneTemplate.

    .spec

    Description
    KamajiControlPlaneTemplateSpec defines the desired state of KamajiControlPlaneTemplate.
    Type
    object
    Required
    template
    PropertyTypeDescription
    templateobject

    KamajiControlPlaneTemplateResource describes the data needed to create a KamajiControlPlane from a template.

    .spec.template

    Description
    KamajiControlPlaneTemplateResource describes the data needed to create a KamajiControlPlane from a template.
    Type
    object
    Required
    spec
    PropertyTypeDescription
    metadataObjectMeta

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

    specobject

    .spec.template.spec

    Type
    object
    PropertyTypeDescription
    addonsobject

    The addons that must be managed by Kamaji, such as CoreDNS, kube-proxy, and konnectivity.

    admissionControllersarray

    List of the admission controllers to configure for the TenantControlPlane kube-apiserver. By default, no admission controllers are enabled, refer to the desired Kubernetes version.

    More info: https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/

    apiServerobject

    ControlPlaneComponent allows the customization for the given component of the control plane.

    controllerManagerobject

    ControlPlaneComponent allows the customization for the given component of the control plane.

    dataStoreNamestring

    The Kamaji DataStore to use for the given TenantControlPlane. Retrieve the list of the allowed ones by issuing "kubectl get datastores.kamaji.clastix.io".

    dataStoreSchemastring

    DataStoreSchema allows to specify the name of the database (for relational DataStores) or the key prefix (for etcd)

    deploymentobject

    Configure how the TenantControlPlane Deployment object should be configured.

    kineobject

    KineComponent allows the customization for the kine component of the control plane. Available only if Kamaji is running using Kine as backing storage.

    kubeletobject

    Configure the Kubelet options, such as the preferred address types, or the expected cgroupfs.

    networkobject

    Configure how the TenantControlPlane should be exposed.

    registrystring

    Override the container registry used to pull the components image. Helpful if running in an air-gapped environment.

    schedulerobject

    ControlPlaneComponent allows the customization for the given component of the control plane.

    .spec.template.spec.addons

    Description
    The addons that must be managed by Kamaji, such as CoreDNS, kube-proxy, and konnectivity.
    Type
    object
    PropertyTypeDescription
    coreDNSobject

    Enables the DNS addon in the Tenant Cluster. The registry and the tag are configurable, the image is hard-coded to coredns.

    konnectivityobject

    Enables the Konnectivity addon in the Tenant Cluster, required if the worker nodes are in a different network.

    kubeProxyobject

    Enables the kube-proxy addon in the Tenant Cluster. The registry and the tag are configurable, the image is hard-coded to kube-proxy.

    .spec.template.spec.addons.coreDNS

    Description
    Enables the DNS addon in the Tenant Cluster. The registry and the tag are configurable, the image is hard-coded to `coredns`.
    Type
    object
    PropertyTypeDescription
    dnsServiceIPsarray

    DNSServiceIPs contains the CoreDNS Service IPs. When set to an empty slice, Kamaji will automatically inflect it from the Service CIDR.

    imageRepositorystring

    ImageRepository sets the container registry to pull images from. if not set, the default ImageRepository will be used instead.

    imageTagstring

    ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

    .spec.template.spec.addons.coreDNS.dnsServiceIPs

    Description
    DNSServiceIPs contains the CoreDNS Service IPs. When set to an empty slice, Kamaji will automatically inflect it from the Service CIDR.
    Type
    array

    .spec.template.spec.addons.coreDNS.dnsServiceIPs[]

    Type
    string

    .spec.template.spec.addons.konnectivity

    Description
    Enables the Konnectivity addon in the Tenant Cluster, required if the worker nodes are in a different network.
    Type
    object
    PropertyTypeDescription
    agentobject
    serverobject

    .spec.template.spec.addons.konnectivity.agent

    Type
    object
    PropertyTypeDescription
    extraArgsarray

    ExtraArgs allows adding additional arguments to said component. WARNING - This option can override existing konnectivity parameters and cause konnectivity components to misbehave in unxpected ways. Only modify if you know what you are doing.

    imagestring

    AgentImage defines the container image for Konnectivity's agent.

    tolerationsarray

    Tolerations for the deployed agent. Can be customized to start the konnectivity-agent even if the nodes are not ready or tainted.

    versionstring

    Version for Konnectivity agent.

    .spec.template.spec.addons.konnectivity.agent.extraArgs

    Description
    ExtraArgs allows adding additional arguments to said component. WARNING - This option can override existing konnectivity parameters and cause konnectivity components to misbehave in unxpected ways. Only modify if you know what you are doing.
    Type
    array

    .spec.template.spec.addons.konnectivity.agent.extraArgs[]

    Type
    string

    .spec.template.spec.addons.konnectivity.agent.tolerations

    Description
    Tolerations for the deployed agent. Can be customized to start the konnectivity-agent even if the nodes are not ready or tainted.
    Type
    array

    .spec.template.spec.addons.konnectivity.agent.tolerations[]

    Description
    The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
    Type
    object
    PropertyTypeDescription
    effectstring

    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

    keystring

    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

    operatorstring

    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    tolerationSecondsinteger

    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

    valuestring

    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

    .spec.template.spec.addons.konnectivity.server

    Type
    object
    Required
    port
    PropertyTypeDescription
    extraArgsarray

    ExtraArgs allows adding additional arguments to said component. WARNING - This option can override existing konnectivity parameters and cause konnectivity components to misbehave in unxpected ways. Only modify if you know what you are doing.

    imagestring

    Container image used by the Konnectivity server.

    portinteger

    The port which Konnectivity server is listening to.

    resourcesobject

    Resources define the amount of CPU and memory to allocate to the Konnectivity server.

    versionstring

    Container image version of the Konnectivity server.

    .spec.template.spec.addons.konnectivity.server.extraArgs

    Description
    ExtraArgs allows adding additional arguments to said component. WARNING - This option can override existing konnectivity parameters and cause konnectivity components to misbehave in unxpected ways. Only modify if you know what you are doing.
    Type
    array

    .spec.template.spec.addons.konnectivity.server.extraArgs[]

    Type
    string

    .spec.template.spec.addons.konnectivity.server.resources

    Description
    Resources define the amount of CPU and memory to allocate to the Konnectivity server.
    Type
    object
    PropertyTypeDescription
    claimsarray

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.addons.konnectivity.server.resources.claims

    Description
    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
    Type
    array

    .spec.template.spec.addons.konnectivity.server.resources.claims[]

    Description
    ResourceClaim references one entry in PodSpec.ResourceClaims.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

    requeststring

    Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

    .spec.template.spec.addons.konnectivity.server.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.addons.konnectivity.server.resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.addons.kubeProxy

    Description
    Enables the kube-proxy addon in the Tenant Cluster. The registry and the tag are configurable, the image is hard-coded to `kube-proxy`.
    Type
    object
    PropertyTypeDescription
    imageRepositorystring

    ImageRepository sets the container registry to pull images from. if not set, the default ImageRepository will be used instead.

    imageTagstring

    ImageTag allows to specify a tag for the image. In case this value is set, kubeadm does not change automatically the version of the above components during upgrades.

    .spec.template.spec.admissionControllers

    Description
    List of the admission controllers to configure for the TenantControlPlane kube-apiserver. By default, no admission controllers are enabled, refer to the desired Kubernetes version. More info: https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/
    Type
    array

    .spec.template.spec.admissionControllers[]

    Type
    string

    .spec.template.spec.apiServer

    Description
    ControlPlaneComponent allows the customization for the given component of the control plane.
    Type
    object
    PropertyTypeDescription
    containerImageNamestring

    In combination with the container registry, it can override the component container image. With no value, the default images will be used.

    extraArgsarray
    extraVolumeMountsarray
    resourcesobject

    ResourceRequirements describes the compute resource requirements.

    .spec.template.spec.apiServer.extraArgs

    Type
    array

    .spec.template.spec.apiServer.extraArgs[]

    Type
    string

    .spec.template.spec.apiServer.extraVolumeMounts

    Type
    array

    .spec.template.spec.apiServer.extraVolumeMounts[]

    Description
    VolumeMount describes a mounting of a Volume within a container.
    Type
    object
    Required
    mountPathname
    PropertyTypeDescription
    mountPathstring

    Path within the container at which the volume should be mounted. Must not contain ':'.

    mountPropagationstring

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

    namestring

    This must match the Name of a Volume.

    readOnlyboolean

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    recursiveReadOnlystring

    RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

    If ReadOnly is false, this field has no meaning and must be unspecified.

    If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

    If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

    If this field is not specified, it is treated as an equivalent of Disabled.

    subPathstring

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

    subPathExprstring

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

    .spec.template.spec.apiServer.resources

    Description
    ResourceRequirements describes the compute resource requirements.
    Type
    object
    PropertyTypeDescription
    claimsarray

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.apiServer.resources.claims

    Description
    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
    Type
    array

    .spec.template.spec.apiServer.resources.claims[]

    Description
    ResourceClaim references one entry in PodSpec.ResourceClaims.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

    requeststring

    Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

    .spec.template.spec.apiServer.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.apiServer.resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.controllerManager

    Description
    ControlPlaneComponent allows the customization for the given component of the control plane.
    Type
    object
    PropertyTypeDescription
    containerImageNamestring

    In combination with the container registry, it can override the component container image. With no value, the default images will be used.

    extraArgsarray
    extraVolumeMountsarray
    resourcesobject

    ResourceRequirements describes the compute resource requirements.

    .spec.template.spec.controllerManager.extraArgs

    Type
    array

    .spec.template.spec.controllerManager.extraArgs[]

    Type
    string

    .spec.template.spec.controllerManager.extraVolumeMounts

    Type
    array

    .spec.template.spec.controllerManager.extraVolumeMounts[]

    Description
    VolumeMount describes a mounting of a Volume within a container.
    Type
    object
    Required
    mountPathname
    PropertyTypeDescription
    mountPathstring

    Path within the container at which the volume should be mounted. Must not contain ':'.

    mountPropagationstring

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

    namestring

    This must match the Name of a Volume.

    readOnlyboolean

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    recursiveReadOnlystring

    RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

    If ReadOnly is false, this field has no meaning and must be unspecified.

    If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

    If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

    If this field is not specified, it is treated as an equivalent of Disabled.

    subPathstring

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

    subPathExprstring

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

    .spec.template.spec.controllerManager.resources

    Description
    ResourceRequirements describes the compute resource requirements.
    Type
    object
    PropertyTypeDescription
    claimsarray

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.controllerManager.resources.claims

    Description
    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
    Type
    array

    .spec.template.spec.controllerManager.resources.claims[]

    Description
    ResourceClaim references one entry in PodSpec.ResourceClaims.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

    requeststring

    Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

    .spec.template.spec.controllerManager.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.controllerManager.resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.deployment

    Description
    Configure how the TenantControlPlane Deployment object should be configured.
    Type
    object
    PropertyTypeDescription
    additionalMetadataobject

    AdditionalMetadata refers to the additional labels and annotations attached to the resulting Deployment managed by Kamaji.

    affinityobject

    Affinity is a group of affinity scheduling rules.

    externalClusterReferenceobject

    ExternalClusterReference allows defining the target Cluster where the Tenant Control Plane components must be deployed. When this value is nil, the Cluster API management cluster will be used as a target. The ExternalClusterReference feature gate must be enabled with one of the available flags.

    extraContainersarray
    extraInitContainersarray
    extraVolumesarray
    nodeSelectorobject
    podAdditionalMetadataobject

    PodAdditionalMetadata defines the additional labels and annotations that must be attached to the resulting Pods managed by the Deployment.

    runtimeClassNamestring
    serviceAccountNamestring
    strategyobject

    DeploymentStrategy describes how to replace existing pods with new ones.

    tolerationsarray
    topologySpreadConstraintsarray

    .spec.template.spec.deployment.additionalMetadata

    Description
    AdditionalMetadata refers to the additional labels and annotations attached to the resulting Deployment managed by Kamaji.
    Type
    object
    PropertyTypeDescription
    annotationsobject
    labelsobject

    .spec.template.spec.deployment.additionalMetadata.annotations

    Type
    object

    .spec.template.spec.deployment.additionalMetadata.labels

    Type
    object

    .spec.template.spec.deployment.affinity

    Description
    Affinity is a group of affinity scheduling rules.
    Type
    object
    PropertyTypeDescription
    nodeAffinityobject

    Describes node affinity scheduling rules for the pod.

    podAffinityobject

    Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

    podAntiAffinityobject

    Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

    .spec.template.spec.deployment.affinity.nodeAffinity

    Description
    Describes node affinity scheduling rules for the pod.
    Type
    object
    PropertyTypeDescription
    preferredDuringSchedulingIgnoredDuringExecutionarray

    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.

    requiredDuringSchedulingIgnoredDuringExecutionobject

    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 an update), the system may or may not try to eventually evict the pod from its node.

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

    Description
    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.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

    Description
    An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
    Type
    object
    Required
    preferenceweight
    PropertyTypeDescription
    preferenceobject

    A node selector term, associated with the corresponding weight.

    weightinteger

    Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

    Description
    A node selector term, associated with the corresponding weight.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    A list of node selector requirements by node's labels.

    matchFieldsarray

    A list of node selector requirements by node's fields.

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions

    Description
    A list of node selector requirements by node's labels.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]

    Description
    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    The label key that the selector applies to.

    operatorstring

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesarray

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values

    Description
    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

    Description
    A list of node selector requirements by node's fields.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]

    Description
    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    The label key that the selector applies to.

    operatorstring

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesarray

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values

    Description
    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

    Description
    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 an update), the system may or may not try to eventually evict the pod from its node.
    Type
    object
    Required
    nodeSelectorTerms
    PropertyTypeDescription
    nodeSelectorTermsarray

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

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

    Description
    Required. A list of node selector terms. The terms are ORed.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

    Description
    A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    A list of node selector requirements by node's labels.

    matchFieldsarray

    A list of node selector requirements by node's fields.

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions

    Description
    A list of node selector requirements by node's labels.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]

    Description
    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    The label key that the selector applies to.

    operatorstring

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesarray

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values

    Description
    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields

    Description
    A list of node selector requirements by node's fields.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]

    Description
    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    The label key that the selector applies to.

    operatorstring

    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

    valuesarray

    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values

    Description
    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity

    Description
    Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
    Type
    object
    PropertyTypeDescription
    preferredDuringSchedulingIgnoredDuringExecutionarray

    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.

    requiredDuringSchedulingIgnoredDuringExecutionarray

    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.

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

    Description
    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.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

    Description
    The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
    Type
    object
    Required
    podAffinityTermweight
    PropertyTypeDescription
    podAffinityTermobject

    Required. A pod affinity term, associated with the corresponding weight.

    weightinteger

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

    Description
    Required. A pod affinity term, associated with the corresponding weight.
    Type
    object
    Required
    topologyKey
    PropertyTypeDescription
    labelSelectorobject

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    matchLabelKeysarray

    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

    mismatchLabelKeysarray

    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

    namespaceSelectorobject

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    namespacesarray

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

    topologyKeystring

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

    Description
    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys

    Description
    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys

    Description
    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

    Description
    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces

    Description
    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

    Description
    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.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

    Description
    Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
    Type
    object
    Required
    topologyKey
    PropertyTypeDescription
    labelSelectorobject

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    matchLabelKeysarray

    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

    mismatchLabelKeysarray

    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

    namespaceSelectorobject

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    namespacesarray

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

    topologyKeystring

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

    Description
    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys

    Description
    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys

    Description
    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

    Description
    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces

    Description
    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    Type
    array

    .spec.template.spec.deployment.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity

    Description
    Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
    Type
    object
    PropertyTypeDescription
    preferredDuringSchedulingIgnoredDuringExecutionarray

    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.

    requiredDuringSchedulingIgnoredDuringExecutionarray

    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.

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

    Description
    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.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

    Description
    The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
    Type
    object
    Required
    podAffinityTermweight
    PropertyTypeDescription
    podAffinityTermobject

    Required. A pod affinity term, associated with the corresponding weight.

    weightinteger

    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

    Description
    Required. A pod affinity term, associated with the corresponding weight.
    Type
    object
    Required
    topologyKey
    PropertyTypeDescription
    labelSelectorobject

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    matchLabelKeysarray

    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

    mismatchLabelKeysarray

    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

    namespaceSelectorobject

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    namespacesarray

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

    topologyKeystring

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

    Description
    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys

    Description
    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys

    Description
    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

    Description
    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces

    Description
    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

    Description
    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.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

    Description
    Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
    Type
    object
    Required
    topologyKey
    PropertyTypeDescription
    labelSelectorobject

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    matchLabelKeysarray

    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.

    mismatchLabelKeysarray

    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

    namespaceSelectorobject

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    namespacesarray

    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

    topologyKeystring

    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

    Description
    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys

    Description
    MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys

    Description
    MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

    Description
    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces

    Description
    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    Type
    array

    .spec.template.spec.deployment.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]

    Type
    string

    .spec.template.spec.deployment.externalClusterReference

    Description
    ExternalClusterReference allows defining the target Cluster where the Tenant Control Plane components must be deployed. When this value is nil, the Cluster API management cluster will be used as a target. The ExternalClusterReference feature gate must be enabled with one of the available flags.
    Type
    object
    Required
    deploymentNamespacekubeconfigSecretKeykubeconfigSecretName
    PropertyTypeDescription
    deploymentNamespacestring

    The Namespace where the resulting TenantControlPlane must be deployed to.

    kubeconfigSecretKeystring

    The key used to extract the kubeconfig from the specified Secret.

    kubeconfigSecretNamestring

    The Secret object containing the kubeconfig used to interact with the remote cluster that will host the Tenant Control Plane resources generated by the Control Plane Provider.

    kubeconfigSecretNamespacestring

    When ExternalClusterReferenceCrossNamespace is enabled allows specifying a different Namespace where the kubeconfig can be retrieved. With ExternalClusterReference this value can be left empty since the KamajiControlPlane object Namespace will be used.

    .spec.template.spec.deployment.extraContainers

    Type
    array

    .spec.template.spec.deployment.extraContainers[]

    Description
    A single application container that you want to run within a pod.
    Type
    object
    Required
    name
    PropertyTypeDescription
    argsarray

    Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

    commandarray

    Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

    envarray

    List of environment variables to set in the container. Cannot be updated.

    envFromarray

    List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

    imagestring

    Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

    imagePullPolicystring

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    lifecycleobject

    Actions that the management system should take in response to container lifecycle events. Cannot be updated.

    livenessProbeobject

    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    namestring

    Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

    portsarray

    List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.

    readinessProbeobject

    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    resizePolicyarray

    Resources resize policy for the container.

    resourcesobject

    Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    restartPolicystring

    RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.

    securityContextobject

    SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

    startupProbeobject

    StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    stdinboolean

    Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

    stdinOnceboolean

    Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

    terminationMessagePathstring

    Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

    terminationMessagePolicystring

    Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

    ttyboolean

    Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

    volumeDevicesarray

    volumeDevices is the list of block devices to be used by the container.

    volumeMountsarray

    Pod volumes to mount into the container's filesystem. Cannot be updated.

    workingDirstring

    Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

    .spec.template.spec.deployment.extraContainers[].args

    Description
    Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    Type
    array

    .spec.template.spec.deployment.extraContainers[].args[]

    Type
    string

    .spec.template.spec.deployment.extraContainers[].command

    Description
    Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    Type
    array

    .spec.template.spec.deployment.extraContainers[].command[]

    Type
    string

    .spec.template.spec.deployment.extraContainers[].env

    Description
    List of environment variables to set in the container. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].env[]

    Description
    EnvVar represents an environment variable present in a Container.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name of the environment variable. Must be a C_IDENTIFIER.

    valuestring

    Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

    valueFromobject

    Source for the environment variable's value. Cannot be used if value is not empty.

    .spec.template.spec.deployment.extraContainers[].env[].valueFrom

    Description
    Source for the environment variable's value. Cannot be used if value is not empty.
    Type
    object
    PropertyTypeDescription
    configMapKeyRefobject

    Selects a key of a ConfigMap.

    fieldRefobject

    Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

    resourceFieldRefobject

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

    secretKeyRefobject

    Selects a key of a secret in the pod's namespace

    .spec.template.spec.deployment.extraContainers[].env[].valueFrom.configMapKeyRef

    Description
    Selects a key of a ConfigMap.
    Type
    object
    Required
    key
    PropertyTypeDescription
    keystring

    The key to select.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the ConfigMap or its key must be defined

    .spec.template.spec.deployment.extraContainers[].env[].valueFrom.fieldRef

    Description
    Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.template.spec.deployment.extraContainers[].env[].valueFrom.resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.template.spec.deployment.extraContainers[].env[].valueFrom.secretKeyRef

    Description
    Selects a key of a secret in the pod's namespace
    Type
    object
    Required
    key
    PropertyTypeDescription
    keystring

    The key of the secret to select from. Must be a valid secret key.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the Secret or its key must be defined

    .spec.template.spec.deployment.extraContainers[].envFrom

    Description
    List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].envFrom[]

    Description
    EnvFromSource represents the source of a set of ConfigMaps or Secrets
    Type
    object
    PropertyTypeDescription
    configMapRefobject

    The ConfigMap to select from

    prefixstring

    Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.

    secretRefobject

    The Secret to select from

    .spec.template.spec.deployment.extraContainers[].envFrom[].configMapRef

    Description
    The ConfigMap to select from
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the ConfigMap must be defined

    .spec.template.spec.deployment.extraContainers[].envFrom[].secretRef

    Description
    The Secret to select from
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the Secret must be defined

    .spec.template.spec.deployment.extraContainers[].lifecycle

    Description
    Actions that the management system should take in response to container lifecycle events. Cannot be updated.
    Type
    object
    PropertyTypeDescription
    postStartobject

    PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

    preStopobject

    PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

    stopSignalstring

    StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart

    Description
    PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    sleepobject

    Sleep represents a duration that the container should sleep.

    tcpSocketobject

    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.sleep

    Description
    Sleep represents a duration that the container should sleep.
    Type
    object
    Required
    seconds
    PropertyTypeDescription
    secondsinteger

    Seconds is the number of seconds to sleep.

    .spec.template.spec.deployment.extraContainers[].lifecycle.postStart.tcpSocket

    Description
    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop

    Description
    PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    sleepobject

    Sleep represents a duration that the container should sleep.

    tcpSocketobject

    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.sleep

    Description
    Sleep represents a duration that the container should sleep.
    Type
    object
    Required
    seconds
    PropertyTypeDescription
    secondsinteger

    Seconds is the number of seconds to sleep.

    .spec.template.spec.deployment.extraContainers[].lifecycle.preStop.tcpSocket

    Description
    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraContainers[].livenessProbe

    Description
    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    failureThresholdinteger

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    grpcobject

    GRPC specifies a GRPC HealthCheckRequest.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    initialDelaySecondsinteger

    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsinteger

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdinteger

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    tcpSocketobject

    TCPSocket specifies a connection to a TCP port.

    terminationGracePeriodSecondsinteger

    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    timeoutSecondsinteger

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    .spec.template.spec.deployment.extraContainers[].livenessProbe.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraContainers[].livenessProbe.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].livenessProbe.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraContainers[].livenessProbe.grpc

    Description
    GRPC specifies a GRPC HealthCheckRequest.
    Type
    object
    Required
    port
    PropertyTypeDescription
    portinteger

    Port number of the gRPC service. Number must be in the range 1 to 65535.

    servicestring

    Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    .spec.template.spec.deployment.extraContainers[].livenessProbe.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraContainers[].livenessProbe.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].livenessProbe.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraContainers[].livenessProbe.tcpSocket

    Description
    TCPSocket specifies a connection to a TCP port.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraContainers[].ports

    Description
    List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].ports[]

    Description
    ContainerPort represents a network port in a single container.
    Type
    object
    Required
    containerPort
    PropertyTypeDescription
    containerPortinteger

    Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

    hostIPstring

    What host IP to bind the external port to.

    hostPortinteger

    Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

    namestring

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

    protocolstring

    Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

    .spec.template.spec.deployment.extraContainers[].readinessProbe

    Description
    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    failureThresholdinteger

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    grpcobject

    GRPC specifies a GRPC HealthCheckRequest.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    initialDelaySecondsinteger

    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsinteger

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdinteger

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    tcpSocketobject

    TCPSocket specifies a connection to a TCP port.

    terminationGracePeriodSecondsinteger

    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    timeoutSecondsinteger

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    .spec.template.spec.deployment.extraContainers[].readinessProbe.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraContainers[].readinessProbe.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].readinessProbe.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraContainers[].readinessProbe.grpc

    Description
    GRPC specifies a GRPC HealthCheckRequest.
    Type
    object
    Required
    port
    PropertyTypeDescription
    portinteger

    Port number of the gRPC service. Number must be in the range 1 to 65535.

    servicestring

    Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    .spec.template.spec.deployment.extraContainers[].readinessProbe.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraContainers[].readinessProbe.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].readinessProbe.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraContainers[].readinessProbe.tcpSocket

    Description
    TCPSocket specifies a connection to a TCP port.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraContainers[].resizePolicy

    Description
    Resources resize policy for the container.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].resizePolicy[]

    Description
    ContainerResizePolicy represents resource resize policy for the container.
    Type
    object
    Required
    resourceNamerestartPolicy
    PropertyTypeDescription
    resourceNamestring

    Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

    restartPolicystring

    Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

    .spec.template.spec.deployment.extraContainers[].resources

    Description
    Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object
    PropertyTypeDescription
    claimsarray

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.deployment.extraContainers[].resources.claims

    Description
    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].resources.claims[]

    Description
    ResourceClaim references one entry in PodSpec.ResourceClaims.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

    requeststring

    Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

    .spec.template.spec.deployment.extraContainers[].resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.deployment.extraContainers[].resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.deployment.extraContainers[].securityContext

    Description
    SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
    Type
    object
    PropertyTypeDescription
    allowPrivilegeEscalationboolean

    AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is:

    1. run as Privileged
    2. has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
    appArmorProfileobject

    appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

    capabilitiesobject

    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

    privilegedboolean

    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

    procMountstring

    procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

    readOnlyRootFilesystemboolean

    Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

    runAsGroupinteger

    The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    runAsNonRootboolean

    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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    runAsUserinteger

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    seLinuxOptionsobject

    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    seccompProfileobject

    The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

    windowsOptionsobject

    The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

    .spec.template.spec.deployment.extraContainers[].securityContext.appArmorProfile

    Description
    appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    Required
    type
    PropertyTypeDescription
    localhostProfilestring

    localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

    typestring

    type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.

    .spec.template.spec.deployment.extraContainers[].securityContext.capabilities

    Description
    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    PropertyTypeDescription
    addarray

    Added capabilities

    droparray

    Removed capabilities

    .spec.template.spec.deployment.extraContainers[].securityContext.capabilities.add

    Description
    Added capabilities
    Type
    array

    .spec.template.spec.deployment.extraContainers[].securityContext.capabilities.add[]

    Description
    Capability represent POSIX capabilities type
    Type
    string

    .spec.template.spec.deployment.extraContainers[].securityContext.capabilities.drop

    Description
    Removed capabilities
    Type
    array

    .spec.template.spec.deployment.extraContainers[].securityContext.capabilities.drop[]

    Description
    Capability represent POSIX capabilities type
    Type
    string

    .spec.template.spec.deployment.extraContainers[].securityContext.seLinuxOptions

    Description
    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    PropertyTypeDescription
    levelstring

    Level is SELinux level label that applies to the container.

    rolestring

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

    typestring

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

    userstring

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

    .spec.template.spec.deployment.extraContainers[].securityContext.seccompProfile

    Description
    The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    Required
    type
    PropertyTypeDescription
    localhostProfilestring

    localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

    typestring

    type indicates which kind of seccomp profile will be applied. Valid options are:

    Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

    .spec.template.spec.deployment.extraContainers[].securityContext.windowsOptions

    Description
    The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
    Type
    object
    PropertyTypeDescription
    gmsaCredentialSpecstring

    GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

    gmsaCredentialSpecNamestring

    GMSACredentialSpecName is the name of the GMSA credential spec to use.

    hostProcessboolean

    HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

    runAsUserNamestring

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

    .spec.template.spec.deployment.extraContainers[].startupProbe

    Description
    StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    failureThresholdinteger

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    grpcobject

    GRPC specifies a GRPC HealthCheckRequest.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    initialDelaySecondsinteger

    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsinteger

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdinteger

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    tcpSocketobject

    TCPSocket specifies a connection to a TCP port.

    terminationGracePeriodSecondsinteger

    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    timeoutSecondsinteger

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    .spec.template.spec.deployment.extraContainers[].startupProbe.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraContainers[].startupProbe.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].startupProbe.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraContainers[].startupProbe.grpc

    Description
    GRPC specifies a GRPC HealthCheckRequest.
    Type
    object
    Required
    port
    PropertyTypeDescription
    portinteger

    Port number of the gRPC service. Number must be in the range 1 to 65535.

    servicestring

    Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    .spec.template.spec.deployment.extraContainers[].startupProbe.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraContainers[].startupProbe.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].startupProbe.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraContainers[].startupProbe.tcpSocket

    Description
    TCPSocket specifies a connection to a TCP port.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraContainers[].volumeDevices

    Description
    volumeDevices is the list of block devices to be used by the container.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].volumeDevices[]

    Description
    volumeDevice describes a mapping of a raw block device within a container.
    Type
    object
    Required
    devicePathname
    PropertyTypeDescription
    devicePathstring

    devicePath is the path inside of the container that the device will be mapped to.

    namestring

    name must match the name of a persistentVolumeClaim in the pod

    .spec.template.spec.deployment.extraContainers[].volumeMounts

    Description
    Pod volumes to mount into the container's filesystem. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraContainers[].volumeMounts[]

    Description
    VolumeMount describes a mounting of a Volume within a container.
    Type
    object
    Required
    mountPathname
    PropertyTypeDescription
    mountPathstring

    Path within the container at which the volume should be mounted. Must not contain ':'.

    mountPropagationstring

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

    namestring

    This must match the Name of a Volume.

    readOnlyboolean

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    recursiveReadOnlystring

    RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

    If ReadOnly is false, this field has no meaning and must be unspecified.

    If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

    If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

    If this field is not specified, it is treated as an equivalent of Disabled.

    subPathstring

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

    subPathExprstring

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

    .spec.template.spec.deployment.extraInitContainers

    Type
    array

    .spec.template.spec.deployment.extraInitContainers[]

    Description
    A single application container that you want to run within a pod.
    Type
    object
    Required
    name
    PropertyTypeDescription
    argsarray

    Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

    commandarray

    Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

    envarray

    List of environment variables to set in the container. Cannot be updated.

    envFromarray

    List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

    imagestring

    Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

    imagePullPolicystring

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

    lifecycleobject

    Actions that the management system should take in response to container lifecycle events. Cannot be updated.

    livenessProbeobject

    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    namestring

    Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

    portsarray

    List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.

    readinessProbeobject

    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    resizePolicyarray

    Resources resize policy for the container.

    resourcesobject

    Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    restartPolicystring

    RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.

    securityContextobject

    SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

    startupProbeobject

    StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    stdinboolean

    Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

    stdinOnceboolean

    Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

    terminationMessagePathstring

    Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

    terminationMessagePolicystring

    Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

    ttyboolean

    Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

    volumeDevicesarray

    volumeDevices is the list of block devices to be used by the container.

    volumeMountsarray

    Pod volumes to mount into the container's filesystem. Cannot be updated.

    workingDirstring

    Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

    .spec.template.spec.deployment.extraInitContainers[].args

    Description
    Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].args[]

    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].command

    Description
    Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].command[]

    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].env

    Description
    List of environment variables to set in the container. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].env[]

    Description
    EnvVar represents an environment variable present in a Container.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name of the environment variable. Must be a C_IDENTIFIER.

    valuestring

    Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

    valueFromobject

    Source for the environment variable's value. Cannot be used if value is not empty.

    .spec.template.spec.deployment.extraInitContainers[].env[].valueFrom

    Description
    Source for the environment variable's value. Cannot be used if value is not empty.
    Type
    object
    PropertyTypeDescription
    configMapKeyRefobject

    Selects a key of a ConfigMap.

    fieldRefobject

    Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

    resourceFieldRefobject

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

    secretKeyRefobject

    Selects a key of a secret in the pod's namespace

    .spec.template.spec.deployment.extraInitContainers[].env[].valueFrom.configMapKeyRef

    Description
    Selects a key of a ConfigMap.
    Type
    object
    Required
    key
    PropertyTypeDescription
    keystring

    The key to select.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the ConfigMap or its key must be defined

    .spec.template.spec.deployment.extraInitContainers[].env[].valueFrom.fieldRef

    Description
    Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.template.spec.deployment.extraInitContainers[].env[].valueFrom.resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.template.spec.deployment.extraInitContainers[].env[].valueFrom.secretKeyRef

    Description
    Selects a key of a secret in the pod's namespace
    Type
    object
    Required
    key
    PropertyTypeDescription
    keystring

    The key of the secret to select from. Must be a valid secret key.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the Secret or its key must be defined

    .spec.template.spec.deployment.extraInitContainers[].envFrom

    Description
    List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].envFrom[]

    Description
    EnvFromSource represents the source of a set of ConfigMaps or Secrets
    Type
    object
    PropertyTypeDescription
    configMapRefobject

    The ConfigMap to select from

    prefixstring

    Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.

    secretRefobject

    The Secret to select from

    .spec.template.spec.deployment.extraInitContainers[].envFrom[].configMapRef

    Description
    The ConfigMap to select from
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the ConfigMap must be defined

    .spec.template.spec.deployment.extraInitContainers[].envFrom[].secretRef

    Description
    The Secret to select from
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    Specify whether the Secret must be defined

    .spec.template.spec.deployment.extraInitContainers[].lifecycle

    Description
    Actions that the management system should take in response to container lifecycle events. Cannot be updated.
    Type
    object
    PropertyTypeDescription
    postStartobject

    PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

    preStopobject

    PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

    stopSignalstring

    StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart

    Description
    PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    sleepobject

    Sleep represents a duration that the container should sleep.

    tcpSocketobject

    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.sleep

    Description
    Sleep represents a duration that the container should sleep.
    Type
    object
    Required
    seconds
    PropertyTypeDescription
    secondsinteger

    Seconds is the number of seconds to sleep.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.postStart.tcpSocket

    Description
    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop

    Description
    PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    sleepobject

    Sleep represents a duration that the container should sleep.

    tcpSocketobject

    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.sleep

    Description
    Sleep represents a duration that the container should sleep.
    Type
    object
    Required
    seconds
    PropertyTypeDescription
    secondsinteger

    Seconds is the number of seconds to sleep.

    .spec.template.spec.deployment.extraInitContainers[].lifecycle.preStop.tcpSocket

    Description
    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe

    Description
    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    failureThresholdinteger

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    grpcobject

    GRPC specifies a GRPC HealthCheckRequest.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    initialDelaySecondsinteger

    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsinteger

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdinteger

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    tcpSocketobject

    TCPSocket specifies a connection to a TCP port.

    terminationGracePeriodSecondsinteger

    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    timeoutSecondsinteger

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.grpc

    Description
    GRPC specifies a GRPC HealthCheckRequest.
    Type
    object
    Required
    port
    PropertyTypeDescription
    portinteger

    Port number of the gRPC service. Number must be in the range 1 to 65535.

    servicestring

    Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraInitContainers[].livenessProbe.tcpSocket

    Description
    TCPSocket specifies a connection to a TCP port.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraInitContainers[].ports

    Description
    List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].ports[]

    Description
    ContainerPort represents a network port in a single container.
    Type
    object
    Required
    containerPort
    PropertyTypeDescription
    containerPortinteger

    Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

    hostIPstring

    What host IP to bind the external port to.

    hostPortinteger

    Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

    namestring

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

    protocolstring

    Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe

    Description
    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    failureThresholdinteger

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    grpcobject

    GRPC specifies a GRPC HealthCheckRequest.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    initialDelaySecondsinteger

    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsinteger

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdinteger

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    tcpSocketobject

    TCPSocket specifies a connection to a TCP port.

    terminationGracePeriodSecondsinteger

    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    timeoutSecondsinteger

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.grpc

    Description
    GRPC specifies a GRPC HealthCheckRequest.
    Type
    object
    Required
    port
    PropertyTypeDescription
    portinteger

    Port number of the gRPC service. Number must be in the range 1 to 65535.

    servicestring

    Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraInitContainers[].readinessProbe.tcpSocket

    Description
    TCPSocket specifies a connection to a TCP port.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraInitContainers[].resizePolicy

    Description
    Resources resize policy for the container.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].resizePolicy[]

    Description
    ContainerResizePolicy represents resource resize policy for the container.
    Type
    object
    Required
    resourceNamerestartPolicy
    PropertyTypeDescription
    resourceNamestring

    Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

    restartPolicystring

    Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

    .spec.template.spec.deployment.extraInitContainers[].resources

    Description
    Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object
    PropertyTypeDescription
    claimsarray

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.deployment.extraInitContainers[].resources.claims

    Description
    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].resources.claims[]

    Description
    ResourceClaim references one entry in PodSpec.ResourceClaims.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

    requeststring

    Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

    .spec.template.spec.deployment.extraInitContainers[].resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.deployment.extraInitContainers[].resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.deployment.extraInitContainers[].securityContext

    Description
    SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
    Type
    object
    PropertyTypeDescription
    allowPrivilegeEscalationboolean

    AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is:

    1. run as Privileged
    2. has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
    appArmorProfileobject

    appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

    capabilitiesobject

    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

    privilegedboolean

    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

    procMountstring

    procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

    readOnlyRootFilesystemboolean

    Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

    runAsGroupinteger

    The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    runAsNonRootboolean

    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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    runAsUserinteger

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    seLinuxOptionsobject

    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    seccompProfileobject

    The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

    windowsOptionsobject

    The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

    .spec.template.spec.deployment.extraInitContainers[].securityContext.appArmorProfile

    Description
    appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    Required
    type
    PropertyTypeDescription
    localhostProfilestring

    localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

    typestring

    type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.

    .spec.template.spec.deployment.extraInitContainers[].securityContext.capabilities

    Description
    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    PropertyTypeDescription
    addarray

    Added capabilities

    droparray

    Removed capabilities

    .spec.template.spec.deployment.extraInitContainers[].securityContext.capabilities.add

    Description
    Added capabilities
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].securityContext.capabilities.add[]

    Description
    Capability represent POSIX capabilities type
    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].securityContext.capabilities.drop

    Description
    Removed capabilities
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].securityContext.capabilities.drop[]

    Description
    Capability represent POSIX capabilities type
    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].securityContext.seLinuxOptions

    Description
    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    PropertyTypeDescription
    levelstring

    Level is SELinux level label that applies to the container.

    rolestring

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

    typestring

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

    userstring

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

    .spec.template.spec.deployment.extraInitContainers[].securityContext.seccompProfile

    Description
    The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
    Type
    object
    Required
    type
    PropertyTypeDescription
    localhostProfilestring

    localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

    typestring

    type indicates which kind of seccomp profile will be applied. Valid options are:

    Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

    .spec.template.spec.deployment.extraInitContainers[].securityContext.windowsOptions

    Description
    The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
    Type
    object
    PropertyTypeDescription
    gmsaCredentialSpecstring

    GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

    gmsaCredentialSpecNamestring

    GMSACredentialSpecName is the name of the GMSA credential spec to use.

    hostProcessboolean

    HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

    runAsUserNamestring

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

    .spec.template.spec.deployment.extraInitContainers[].startupProbe

    Description
    StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    Type
    object
    PropertyTypeDescription
    execobject

    Exec specifies a command to execute in the container.

    failureThresholdinteger

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    grpcobject

    GRPC specifies a GRPC HealthCheckRequest.

    httpGetobject

    HTTPGet specifies an HTTP GET request to perform.

    initialDelaySecondsinteger

    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    periodSecondsinteger

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    successThresholdinteger

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    tcpSocketobject

    TCPSocket specifies a connection to a TCP port.

    terminationGracePeriodSecondsinteger

    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    timeoutSecondsinteger

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.exec

    Description
    Exec specifies a command to execute in the container.
    Type
    object
    PropertyTypeDescription
    commandarray

    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.exec.command

    Description
    Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.exec.command[]

    Type
    string

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.grpc

    Description
    GRPC specifies a GRPC HealthCheckRequest.
    Type
    object
    Required
    port
    PropertyTypeDescription
    portinteger

    Port number of the gRPC service. Number must be in the range 1 to 65535.

    servicestring

    Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.httpGet

    Description
    HTTPGet specifies an HTTP GET request to perform.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    httpHeadersarray

    Custom headers to set in the request. HTTP allows repeated headers.

    pathstring

    Path to access on the HTTP server.

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    schemestring

    Scheme to use for connecting to the host. Defaults to HTTP.

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.httpGet.httpHeaders

    Description
    Custom headers to set in the request. HTTP allows repeated headers.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.httpGet.httpHeaders[]

    Description
    HTTPHeader describes a custom header to be used in HTTP probes
    Type
    object
    Required
    namevalue
    PropertyTypeDescription
    namestring

    The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

    valuestring

    The header field value

    .spec.template.spec.deployment.extraInitContainers[].startupProbe.tcpSocket

    Description
    TCPSocket specifies a connection to a TCP port.
    Type
    object
    Required
    port
    PropertyTypeDescription
    hoststring

    Optional: Host name to connect to, defaults to the pod IP.

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    .spec.template.spec.deployment.extraInitContainers[].volumeDevices

    Description
    volumeDevices is the list of block devices to be used by the container.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].volumeDevices[]

    Description
    volumeDevice describes a mapping of a raw block device within a container.
    Type
    object
    Required
    devicePathname
    PropertyTypeDescription
    devicePathstring

    devicePath is the path inside of the container that the device will be mapped to.

    namestring

    name must match the name of a persistentVolumeClaim in the pod

    .spec.template.spec.deployment.extraInitContainers[].volumeMounts

    Description
    Pod volumes to mount into the container's filesystem. Cannot be updated.
    Type
    array

    .spec.template.spec.deployment.extraInitContainers[].volumeMounts[]

    Description
    VolumeMount describes a mounting of a Volume within a container.
    Type
    object
    Required
    mountPathname
    PropertyTypeDescription
    mountPathstring

    Path within the container at which the volume should be mounted. Must not contain ':'.

    mountPropagationstring

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

    namestring

    This must match the Name of a Volume.

    readOnlyboolean

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    recursiveReadOnlystring

    RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

    If ReadOnly is false, this field has no meaning and must be unspecified.

    If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

    If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

    If this field is not specified, it is treated as an equivalent of Disabled.

    subPathstring

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

    subPathExprstring

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

    .spec.template.spec.deployment.extraVolumes

    Type
    array

    .spec.template.spec.deployment.extraVolumes[]

    Description
    Volume represents a named volume in a pod that may be accessed by any container in the pod.
    Type
    object
    Required
    name
    PropertyTypeDescription
    awsElasticBlockStoreobject

    awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

    azureDiskobject

    azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.

    azureFileobject

    azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.

    cephfsobject

    cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.

    cinderobject

    cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

    configMapobject

    configMap represents a configMap that should populate this volume

    csiobject

    csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

    downwardAPIobject

    downwardAPI represents downward API about the pod that should populate this volume

    emptyDirobject

    emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    ephemeralobject

    ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

    Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

    Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

    Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

    A pod can use both types of ephemeral volumes and persistent volumes at the same time.

    fcobject

    fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

    flexVolumeobject

    flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.

    flockerobject

    flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.

    gcePersistentDiskobject

    gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

    gitRepoobject

    gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

    glusterfsobject

    glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md

    hostPathobject

    hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

    imageobject

    image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:

    • Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
    • Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
    • IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.

    The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

    iscsiobject

    iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

    namestring

    name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    nfsobject

    nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    persistentVolumeClaimobject

    persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    photonPersistentDiskobject

    photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.

    portworxVolumeobject

    portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.

    projectedobject

    projected items for all in one resources secrets, configmaps, and downward API

    quobyteobject

    quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.

    rbdobject

    rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md

    scaleIOobject

    scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.

    secretobject

    secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

    storageosobject

    storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.

    vsphereVolumeobject

    vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.

    .spec.template.spec.deployment.extraVolumes[].awsElasticBlockStore

    Description
    awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
    Type
    object
    Required
    volumeID
    PropertyTypeDescription
    fsTypestring

    fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

    partitioninteger

    partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

    readOnlyboolean

    readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

    volumeIDstring

    volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

    .spec.template.spec.deployment.extraVolumes[].azureDisk

    Description
    azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
    Type
    object
    Required
    diskNamediskURI
    PropertyTypeDescription
    cachingModestring

    cachingMode is the Host Caching mode: None, Read Only, Read Write.

    diskNamestring

    diskName is the Name of the data disk in the blob storage

    diskURIstring

    diskURI is the URI of data disk in the blob storage

    fsTypestring

    fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    kindstring

    kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared

    readOnlyboolean

    readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    .spec.template.spec.deployment.extraVolumes[].azureFile

    Description
    azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
    Type
    object
    Required
    secretNameshareName
    PropertyTypeDescription
    readOnlyboolean

    readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    secretNamestring

    secretName is the name of secret that contains Azure Storage Account Name and Key

    shareNamestring

    shareName is the azure share Name

    .spec.template.spec.deployment.extraVolumes[].cephfs

    Description
    cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
    Type
    object
    Required
    monitors
    PropertyTypeDescription
    monitorsarray

    monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

    pathstring

    path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

    readOnlyboolean

    readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

    secretFilestring

    secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

    secretRefobject

    secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

    userstring

    user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

    .spec.template.spec.deployment.extraVolumes[].cephfs.monitors

    Description
    monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].cephfs.monitors[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].cephfs.secretRef

    Description
    secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].cinder

    Description
    cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    Type
    object
    Required
    volumeID
    PropertyTypeDescription
    fsTypestring

    fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

    readOnlyboolean

    readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

    secretRefobject

    secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

    volumeIDstring

    volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

    .spec.template.spec.deployment.extraVolumes[].cinder.secretRef

    Description
    secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].configMap

    Description
    configMap represents a configMap that should populate this volume
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    optional specify whether the ConfigMap or its keys must be defined

    .spec.template.spec.deployment.extraVolumes[].configMap.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.template.spec.deployment.extraVolumes[].csi

    Description
    csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
    Type
    object
    Required
    driver
    PropertyTypeDescription
    driverstring

    driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

    fsTypestring

    fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

    nodePublishSecretRefobject

    nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

    readOnlyboolean

    readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

    volumeAttributesobject

    volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

    .spec.template.spec.deployment.extraVolumes[].csi.nodePublishSecretRef

    Description
    nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].csi.volumeAttributes

    Description
    volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
    Type
    object

    .spec.template.spec.deployment.extraVolumes[].downwardAPI

    Description
    downwardAPI represents downward API about the pod that should populate this volume
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    itemsarray

    Items is a list of downward API volume file

    .spec.template.spec.deployment.extraVolumes[].downwardAPI.items

    Description
    Items is a list of downward API volume file
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].downwardAPI.items[]

    Description
    DownwardAPIVolumeFile represents information to create the file containing the pod field
    Type
    object
    Required
    path
    PropertyTypeDescription
    fieldRefobject

    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

    modeinteger

    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

    resourceFieldRefobject

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

    .spec.template.spec.deployment.extraVolumes[].downwardAPI.items[].fieldRef

    Description
    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.template.spec.deployment.extraVolumes[].downwardAPI.items[].resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.template.spec.deployment.extraVolumes[].emptyDir

    Description
    emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
    Type
    object
    PropertyTypeDescription
    mediumstring

    medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    sizeLimit

    sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    .spec.template.spec.deployment.extraVolumes[].ephemeral

    Description
    ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.
    Type
    object
    PropertyTypeDescription
    volumeClaimTemplateobject

    Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

    An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

    This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

    Required, must not be nil.

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate

    Description
    Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.
    Type
    object
    Required
    spec
    PropertyTypeDescription
    metadataObjectMeta

    May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

    specobject

    The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec

    Description
    The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
    Type
    object
    PropertyTypeDescription
    accessModesarray

    accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

    dataSourceobject

    dataSource field can be used to specify either:

    • An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
    • An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
    dataSourceRefobject

    dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef:

    • While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
    • While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
    • While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
    resourcesobject

    resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

    selectorobject

    selector is a label query over volumes to consider for binding.

    storageClassNamestring

    storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

    volumeAttributesClassNamestring

    volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).

    volumeModestring

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

    volumeNamestring

    volumeName is the binding reference to the PersistentVolume backing this claim.

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.accessModes

    Description
    accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.accessModes[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.dataSource

    Description
    dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
    Type
    object
    Required
    kindname
    PropertyTypeDescription
    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

    Description
    dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
    Type
    object
    Required
    kindname
    PropertyTypeDescription
    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    namespacestring

    Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.resources

    Description
    resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
    Type
    object
    PropertyTypeDescription
    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.selector

    Description
    selector is a label query over volumes to consider for binding.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.extraVolumes[].fc

    Description
    fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
    Type
    object
    PropertyTypeDescription
    fsTypestring

    fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    luninteger

    lun is Optional: FC target lun number

    readOnlyboolean

    readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    targetWWNsarray

    targetWWNs is Optional: FC target worldwide names (WWNs)

    wwidsarray

    wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

    .spec.template.spec.deployment.extraVolumes[].fc.targetWWNs

    Description
    targetWWNs is Optional: FC target worldwide names (WWNs)
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].fc.targetWWNs[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].fc.wwids

    Description
    wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].fc.wwids[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].flexVolume

    Description
    flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
    Type
    object
    Required
    driver
    PropertyTypeDescription
    driverstring

    driver is the name of the driver to use for this volume.

    fsTypestring

    fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

    optionsobject

    options is Optional: this field holds extra command options if any.

    readOnlyboolean

    readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    secretRefobject

    secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

    .spec.template.spec.deployment.extraVolumes[].flexVolume.options

    Description
    options is Optional: this field holds extra command options if any.
    Type
    object

    .spec.template.spec.deployment.extraVolumes[].flexVolume.secretRef

    Description
    secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].flocker

    Description
    flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
    Type
    object
    PropertyTypeDescription
    datasetNamestring

    datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated

    datasetUUIDstring

    datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

    .spec.template.spec.deployment.extraVolumes[].gcePersistentDisk

    Description
    gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
    Type
    object
    Required
    pdName
    PropertyTypeDescription
    fsTypestring

    fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

    partitioninteger

    partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

    pdNamestring

    pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

    readOnlyboolean

    readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

    .spec.template.spec.deployment.extraVolumes[].gitRepo

    Description
    gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
    Type
    object
    Required
    repository
    PropertyTypeDescription
    directorystring

    directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

    repositorystring

    repository is the URL

    revisionstring

    revision is the commit hash for the specified revision.

    .spec.template.spec.deployment.extraVolumes[].glusterfs

    Description
    glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md
    Type
    object
    Required
    endpointspath
    PropertyTypeDescription
    endpointsstring

    endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

    pathstring

    path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

    readOnlyboolean

    readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

    .spec.template.spec.deployment.extraVolumes[].hostPath

    Description
    hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
    Type
    object
    Required
    path
    PropertyTypeDescription
    pathstring

    path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

    typestring

    type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

    .spec.template.spec.deployment.extraVolumes[].image

    Description
    image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided: - Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
    Type
    object
    PropertyTypeDescription
    pullPolicystring

    Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.

    referencestring

    Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

    .spec.template.spec.deployment.extraVolumes[].iscsi

    Description
    iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
    Type
    object
    Required
    iqnluntargetPortal
    PropertyTypeDescription
    chapAuthDiscoveryboolean

    chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

    chapAuthSessionboolean

    chapAuthSession defines whether support iSCSI Session CHAP authentication

    fsTypestring

    fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

    initiatorNamestring

    initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.

    iqnstring

    iqn is the target iSCSI Qualified Name.

    iscsiInterfacestring

    iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

    luninteger

    lun represents iSCSI Target Lun number.

    portalsarray

    portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

    readOnlyboolean

    readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

    secretRefobject

    secretRef is the CHAP Secret for iSCSI target and initiator authentication

    targetPortalstring

    targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

    .spec.template.spec.deployment.extraVolumes[].iscsi.portals

    Description
    portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].iscsi.portals[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].iscsi.secretRef

    Description
    secretRef is the CHAP Secret for iSCSI target and initiator authentication
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].nfs

    Description
    nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
    Type
    object
    Required
    pathserver
    PropertyTypeDescription
    pathstring

    path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    readOnlyboolean

    readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    serverstring

    server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

    .spec.template.spec.deployment.extraVolumes[].persistentVolumeClaim

    Description
    persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    Type
    object
    Required
    claimName
    PropertyTypeDescription
    claimNamestring

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    readOnlyboolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

    .spec.template.spec.deployment.extraVolumes[].photonPersistentDisk

    Description
    photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
    Type
    object
    Required
    pdID
    PropertyTypeDescription
    fsTypestring

    fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    pdIDstring

    pdID is the ID that identifies Photon Controller persistent disk

    .spec.template.spec.deployment.extraVolumes[].portworxVolume

    Description
    portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
    Type
    object
    Required
    volumeID
    PropertyTypeDescription
    fsTypestring

    fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.

    readOnlyboolean

    readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    volumeIDstring

    volumeID uniquely identifies a Portworx volume

    .spec.template.spec.deployment.extraVolumes[].projected

    Description
    projected items for all in one resources secrets, configmaps, and downward API
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    sourcesarray

    sources is the list of volume projections. Each entry in this list handles one source.

    .spec.template.spec.deployment.extraVolumes[].projected.sources

    Description
    sources is the list of volume projections. Each entry in this list handles one source.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].projected.sources[]

    Description
    Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
    Type
    object
    PropertyTypeDescription
    clusterTrustBundleobject

    ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

    Alpha, gated by the ClusterTrustBundleProjection feature gate.

    ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

    Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

    configMapobject

    configMap information about the configMap data to project

    downwardAPIobject

    downwardAPI information about the downwardAPI data to project

    secretobject

    secret information about the secret data to project

    serviceAccountTokenobject

    serviceAccountToken is information about the serviceAccountToken data to project

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].clusterTrustBundle

    Description
    ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
    Type
    object
    Required
    path
    PropertyTypeDescription
    labelSelectorobject

    Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

    namestring

    Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

    optionalboolean

    If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.

    pathstring

    Relative path from the volume root to write the bundle.

    signerNamestring

    Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].clusterTrustBundle.labelSelector

    Description
    Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].configMap

    Description
    configMap information about the configMap data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    optional specify whether the ConfigMap or its keys must be defined

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].configMap.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].downwardAPI

    Description
    downwardAPI information about the downwardAPI data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    Items is a list of DownwardAPIVolume file

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].downwardAPI.items

    Description
    Items is a list of DownwardAPIVolume file
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].downwardAPI.items[]

    Description
    DownwardAPIVolumeFile represents information to create the file containing the pod field
    Type
    object
    Required
    path
    PropertyTypeDescription
    fieldRefobject

    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

    modeinteger

    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

    resourceFieldRefobject

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].downwardAPI.items[].fieldRef

    Description
    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].downwardAPI.items[].resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].secret

    Description
    secret information about the secret data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    optional field specify whether the Secret or its key must be defined

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].secret.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.template.spec.deployment.extraVolumes[].projected.sources[].serviceAccountToken

    Description
    serviceAccountToken is information about the serviceAccountToken data to project
    Type
    object
    Required
    path
    PropertyTypeDescription
    audiencestring

    audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

    expirationSecondsinteger

    expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

    pathstring

    path is the path relative to the mount point of the file to project the token into.

    .spec.template.spec.deployment.extraVolumes[].quobyte

    Description
    quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
    Type
    object
    Required
    registryvolume
    PropertyTypeDescription
    groupstring

    group to map volume access to Default is no group

    readOnlyboolean

    readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

    registrystring

    registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

    tenantstring

    tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

    userstring

    user to map volume access to Defaults to serivceaccount user

    volumestring

    volume is a string that references an already created Quobyte volume by name.

    .spec.template.spec.deployment.extraVolumes[].rbd

    Description
    rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md
    Type
    object
    Required
    imagemonitors
    PropertyTypeDescription
    fsTypestring

    fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd

    imagestring

    image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    keyringstring

    keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    monitorsarray

    monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    poolstring

    pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    readOnlyboolean

    readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    secretRefobject

    secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    userstring

    user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

    .spec.template.spec.deployment.extraVolumes[].rbd.monitors

    Description
    monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].rbd.monitors[]

    Type
    string

    .spec.template.spec.deployment.extraVolumes[].rbd.secretRef

    Description
    secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].scaleIO

    Description
    scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
    Type
    object
    Required
    gatewaysecretRefsystem
    PropertyTypeDescription
    fsTypestring

    fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".

    gatewaystring

    gateway is the host address of the ScaleIO API Gateway.

    protectionDomainstring

    protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

    readOnlyboolean

    readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    secretRefobject

    secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

    sslEnabledboolean

    sslEnabled Flag enable/disable SSL communication with Gateway, default false

    storageModestring

    storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

    storagePoolstring

    storagePool is the ScaleIO Storage Pool associated with the protection domain.

    systemstring

    system is the name of the storage system as configured in ScaleIO.

    volumeNamestring

    volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

    .spec.template.spec.deployment.extraVolumes[].scaleIO.secretRef

    Description
    secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].secret

    Description
    secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    itemsarray

    items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    optionalboolean

    optional field specify whether the Secret or its keys must be defined

    secretNamestring

    secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

    .spec.template.spec.deployment.extraVolumes[].secret.items

    Description
    items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.template.spec.deployment.extraVolumes[].secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.template.spec.deployment.extraVolumes[].storageos

    Description
    storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
    Type
    object
    PropertyTypeDescription
    fsTypestring

    fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    readOnlyboolean

    readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    secretRefobject

    secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

    volumeNamestring

    volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

    volumeNamespacestring

    volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

    .spec.template.spec.deployment.extraVolumes[].storageos.secretRef

    Description
    secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.deployment.extraVolumes[].vsphereVolume

    Description
    vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.
    Type
    object
    Required
    volumePath
    PropertyTypeDescription
    fsTypestring

    fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    storagePolicyIDstring

    storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

    storagePolicyNamestring

    storagePolicyName is the storage Policy Based Management (SPBM) profile name.

    volumePathstring

    volumePath is the path that identifies vSphere volume vmdk

    .spec.template.spec.deployment.nodeSelector

    Type
    object

    .spec.template.spec.deployment.podAdditionalMetadata

    Description
    PodAdditionalMetadata defines the additional labels and annotations that must be attached to the resulting Pods managed by the Deployment.
    Type
    object
    PropertyTypeDescription
    annotationsobject
    labelsobject

    .spec.template.spec.deployment.podAdditionalMetadata.annotations

    Type
    object

    .spec.template.spec.deployment.podAdditionalMetadata.labels

    Type
    object

    .spec.template.spec.deployment.strategy

    Description
    DeploymentStrategy describes how to replace existing pods with new ones.
    Type
    object
    PropertyTypeDescription
    rollingUpdateobject

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

    typestring

    Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

    .spec.template.spec.deployment.strategy.rollingUpdate

    Description
    Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
    Type
    object
    PropertyTypeDescription
    maxSurge

    The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet 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 ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

    maxUnavailable

    The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

    .spec.template.spec.deployment.tolerations

    Type
    array

    .spec.template.spec.deployment.tolerations[]

    Description
    The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
    Type
    object
    PropertyTypeDescription
    effectstring

    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

    keystring

    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

    operatorstring

    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    tolerationSecondsinteger

    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

    valuestring

    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

    .spec.template.spec.deployment.topologySpreadConstraints

    Type
    array

    .spec.template.spec.deployment.topologySpreadConstraints[]

    Description
    TopologySpreadConstraint specifies how to spread matching pods among the given topology.
    Type
    object
    Required
    maxSkewtopologyKeywhenUnsatisfiable
    PropertyTypeDescription
    labelSelectorobject

    LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

    matchLabelKeysarray

    MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.

    This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).

    maxSkewinteger

    MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P |

    • if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1).
    • if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.
    minDomainsinteger

    MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

    For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.

    nodeAffinityPolicystring

    NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are:

    • Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
    • Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

    If this value is nil, the behavior is equivalent to the Honor policy.

    nodeTaintsPolicystring

    NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are:

    • Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included.
    • Ignore: node taints are ignored. All nodes are included.

    If this value is nil, the behavior is equivalent to the Ignore policy.

    topologyKeystring

    TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.

    whenUnsatisfiablestring

    WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.

    • DoNotSchedule (default) tells the scheduler not to schedule it.
    • ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

    .spec.template.spec.deployment.topologySpreadConstraints[].labelSelector

    Description
    LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.template.spec.deployment.topologySpreadConstraints[].labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.template.spec.deployment.topologySpreadConstraints[].labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.template.spec.deployment.topologySpreadConstraints[].labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.template.spec.deployment.topologySpreadConstraints[].labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.template.spec.deployment.topologySpreadConstraints[].labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.template.spec.deployment.topologySpreadConstraints[].matchLabelKeys

    Description
    MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
    Type
    array

    .spec.template.spec.deployment.topologySpreadConstraints[].matchLabelKeys[]

    Type
    string

    .spec.template.spec.kine

    Description
    KineComponent allows the customization for the kine component of the control plane. Available only if Kamaji is running using Kine as backing storage.
    Type
    object
    PropertyTypeDescription
    extraArgsarray
    resourcesobject

    ResourceRequirements describes the compute resource requirements.

    .spec.template.spec.kine.extraArgs

    Type
    array

    .spec.template.spec.kine.extraArgs[]

    Type
    string

    .spec.template.spec.kine.resources

    Description
    ResourceRequirements describes the compute resource requirements.
    Type
    object
    PropertyTypeDescription
    claimsarray

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.kine.resources.claims

    Description
    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
    Type
    array

    .spec.template.spec.kine.resources.claims[]

    Description
    ResourceClaim references one entry in PodSpec.ResourceClaims.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

    requeststring

    Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

    .spec.template.spec.kine.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.kine.resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.kubelet

    Description
    Configure the Kubelet options, such as the preferred address types, or the expected cgroupfs.
    Type
    object
    PropertyTypeDescription
    cgroupfsstring

    CGroupFS defines the cgroup driver for Kubelet https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/configure-cgroup-driver/

    preferredAddressTypesarray

    Ordered list of the preferred NodeAddressTypes to use for kubelet connections. Default to Hostname, InternalIP, ExternalIP.

    .spec.template.spec.kubelet.preferredAddressTypes

    Description
    Ordered list of the preferred NodeAddressTypes to use for kubelet connections. Default to Hostname, InternalIP, ExternalIP.
    Type
    array

    .spec.template.spec.kubelet.preferredAddressTypes[]

    Type
    string

    .spec.template.spec.network

    Description
    Configure how the TenantControlPlane should be exposed.
    Type
    object
    PropertyTypeDescription
    certSANsarray

    Configure additional Subject Address Names for the kube-apiserver certificate, useful if the TenantControlPlane is going to be exposed behind a FQDN with NAT.

    dnsServiceIPsarray

    DNSServiceIPs contains the DNS Service IPs. If the CoreDNS addon is specified, its DNSServiceIPs will be used instead. When set to an empty slice, Kamaji will automatically inflect it from the Service CIDR.

    ingressobject

    When specified, the KamajiControlPlane will be reachable using an Ingress object deployed in the management cluster.

    loadBalancerConfigobject

    Optional configuration for the LoadBalancer service that exposes the Kamaji control plane.

    serviceAddressstring

    This field can be used in case of pre-assigned address, such as a VIP, helping when serviceType is NodePort.

    serviceAnnotationsobject
    serviceLabelsobject
    serviceTypestring

    Service Type string describes ingress methods for a service

    .spec.template.spec.network.certSANs

    Description
    Configure additional Subject Address Names for the kube-apiserver certificate, useful if the TenantControlPlane is going to be exposed behind a FQDN with NAT.
    Type
    array

    .spec.template.spec.network.certSANs[]

    Type
    string

    .spec.template.spec.network.dnsServiceIPs

    Description
    DNSServiceIPs contains the DNS Service IPs. If the CoreDNS addon is specified, its DNSServiceIPs will be used instead. When set to an empty slice, Kamaji will automatically inflect it from the Service CIDR.
    Type
    array

    .spec.template.spec.network.dnsServiceIPs[]

    Type
    string

    .spec.template.spec.network.ingress

    Description
    When specified, the KamajiControlPlane will be reachable using an Ingress object deployed in the management cluster.
    Type
    object
    Required
    hostname
    PropertyTypeDescription
    classNamestring

    Defines the Ingress Class for the Ingress object.

    extraAnnotationsobject

    Defines the extra annotations for the Ingress object. Useful if you need to define TLS/SSL passthrough, or other Ingress Controller-specific options.

    extraLabelsobject

    Defines the extra labels for the Ingress object.

    hostnamestring

    Defines the hostname for the Ingress object. When using an Ingress object the FQDN is automatically added to the Certificate SANs.

    .spec.template.spec.network.ingress.extraAnnotations

    Description
    Defines the extra annotations for the Ingress object. Useful if you need to define TLS/SSL passthrough, or other Ingress Controller-specific options.
    Type
    object

    .spec.template.spec.network.ingress.extraLabels

    Description
    Defines the extra labels for the Ingress object.
    Type
    object

    .spec.template.spec.network.loadBalancerConfig

    Description
    Optional configuration for the LoadBalancer service that exposes the Kamaji control plane.
    Type
    object
    PropertyTypeDescription
    loadBalancerClassstring

    Specify the LoadBalancer class in case of multiple load balancer implementations. Field supported only for Tenant Control Plane instances exposed using a LoadBalancer Service.

    loadBalancerSourceRangesarray

    LoadBalancerSourceRanges restricts the IP ranges that can access the LoadBalancer type Service. This field defines a list of IP address ranges (in CIDR format) that are allowed to access the service. If left empty, the service will allow traffic from all IP ranges (0.0.0.0/0). This feature is useful for restricting access to API servers or services to specific networks for security purposes. Example: {"192.168.1.0/24", "10.0.0.0/8"}

    .spec.template.spec.network.loadBalancerConfig.loadBalancerSourceRanges

    Description
    LoadBalancerSourceRanges restricts the IP ranges that can access the LoadBalancer type Service. This field defines a list of IP address ranges (in CIDR format) that are allowed to access the service. If left empty, the service will allow traffic from all IP ranges (0.0.0.0/0). This feature is useful for restricting access to API servers or services to specific networks for security purposes. Example: {"192.168.1.0/24", "10.0.0.0/8"}
    Type
    array

    .spec.template.spec.network.loadBalancerConfig.loadBalancerSourceRanges[]

    Type
    string

    .spec.template.spec.network.serviceAnnotations

    Type
    object

    .spec.template.spec.network.serviceLabels

    Type
    object

    .spec.template.spec.scheduler

    Description
    ControlPlaneComponent allows the customization for the given component of the control plane.
    Type
    object
    PropertyTypeDescription
    containerImageNamestring

    In combination with the container registry, it can override the component container image. With no value, the default images will be used.

    extraArgsarray
    extraVolumeMountsarray
    resourcesobject

    ResourceRequirements describes the compute resource requirements.

    .spec.template.spec.scheduler.extraArgs

    Type
    array

    .spec.template.spec.scheduler.extraArgs[]

    Type
    string

    .spec.template.spec.scheduler.extraVolumeMounts

    Type
    array

    .spec.template.spec.scheduler.extraVolumeMounts[]

    Description
    VolumeMount describes a mounting of a Volume within a container.
    Type
    object
    Required
    mountPathname
    PropertyTypeDescription
    mountPathstring

    Path within the container at which the volume should be mounted. Must not contain ':'.

    mountPropagationstring

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).

    namestring

    This must match the Name of a Volume.

    readOnlyboolean

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    recursiveReadOnlystring

    RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

    If ReadOnly is false, this field has no meaning and must be unspecified.

    If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

    If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

    If this field is not specified, it is treated as an equivalent of Disabled.

    subPathstring

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

    subPathExprstring

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

    .spec.template.spec.scheduler.resources

    Description
    ResourceRequirements describes the compute resource requirements.
    Type
    object
    PropertyTypeDescription
    claimsarray

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    limitsobject

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

    requestsobject

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.template.spec.scheduler.resources.claims

    Description
    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
    Type
    array

    .spec.template.spec.scheduler.resources.claims[]

    Description
    ResourceClaim references one entry in PodSpec.ResourceClaims.
    Type
    object
    Required
    name
    PropertyTypeDescription
    namestring

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

    requeststring

    Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

    .spec.template.spec.scheduler.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.template.spec.scheduler.resources.requests

    Description
    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    API Endpoints

    The following API endpoints are available:

    • /apis/controlplane.cluster.x-k8s.io/v1alpha1/namespaces/{namespace}/kamajicontrolplanetemplates
      • DELETE: delete collection of KamajiControlPlaneTemplate
      • GET: list objects of kind KamajiControlPlaneTemplate
      • POST: create a new KamajiControlPlaneTemplate
    • /apis/controlplane.cluster.x-k8s.io/v1alpha1/namespaces/{namespace}/kamajicontrolplanetemplates/{name}
      • DELETE: delete the specified KamajiControlPlaneTemplate
      • GET: read the specified KamajiControlPlaneTemplate
      • PATCH: partially update the specified KamajiControlPlaneTemplate
      • PUT: replace the specified KamajiControlPlaneTemplate

    /apis/controlplane.cluster.x-k8s.io/v1alpha1/namespaces/{namespace}/kamajicontrolplanetemplates

    HTTP method
    DELETE
    Description
    delete collection of KamajiControlPlaneTemplate
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind KamajiControlPlaneTemplate
    HTTP responses
    HTTP codeResponse body
    200 - OKKamajiControlPlaneTemplateList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new KamajiControlPlaneTemplate
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    Body parameters
    ParameterTypeDescription
    bodyKamajiControlPlaneTemplate schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKKamajiControlPlaneTemplate schema
    201 - CreatedKamajiControlPlaneTemplate schema
    202 - AcceptedKamajiControlPlaneTemplate schema
    401 - UnauthorizedEmpty

    /apis/controlplane.cluster.x-k8s.io/v1alpha1/namespaces/{namespace}/kamajicontrolplanetemplates/{name}

    HTTP method
    DELETE
    Description
    delete the specified KamajiControlPlaneTemplate
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    read the specified KamajiControlPlaneTemplate
    HTTP responses
    HTTP codeResponse body
    200 - OKKamajiControlPlaneTemplate schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update the specified KamajiControlPlaneTemplate
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    HTTP responses
    HTTP codeResponse body
    200 - OKKamajiControlPlaneTemplate schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace the specified KamajiControlPlaneTemplate
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    Body parameters
    ParameterTypeDescription
    bodyKamajiControlPlaneTemplate schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKKamajiControlPlaneTemplate schema
    201 - CreatedKamajiControlPlaneTemplate schema
    401 - UnauthorizedEmpty