Retrieve Project Templates
This API can be used to retrieve all allowed templates of this project.
Project Templates example​
An example Project Templates:
apiVersion: management.loft.sh/v1
defaultSpaceTemplate: my-default-space-template
defaultVirtualClusterTemplate: my-default-vcluster-template
kind: ProjectTemplates
metadata:
creationTimestamp: null
spaceTemplates:
- apiVersion: management.loft.sh/v1
kind: SpaceTemplate
metadata:
creationTimestamp: null
name: my-default-space-template
spec:
template:
instanceTemplate:
metadata: {}
metadata: {}
status: {}
virtualClusterTemplates:
- apiVersion: management.loft.sh/v1
kind: VirtualClusterTemplate
metadata:
creationTimestamp: null
name: my-default-vcluster-template
spec:
template:
accessPoint:
ingress: {}
helmRelease:
chart: {}
instanceTemplate:
metadata: {}
metadata: {}
pro: {}
spaceTemplate:
metadata: {}
status: {}
Project Templates reference​
defaultVirtualClusterTemplate
required string ​
DefaultVirtualClusterTemplate is the default template for the project
defaultVirtualClusterTemplate
required string ​virtualClusterTemplates
required object[] ​
VirtualClusterTemplates holds all the allowed virtual cluster templates
virtualClusterTemplates
required object[] ​kind
required string ​
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​apiVersion
required string ​
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion
required string ​metadata
required object ​
metadata
required object ​name
required string ​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​generateName
required string ​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string ​namespace
required string ​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string ​selfLink
required string ​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string ​uid
required string ​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​resourceVersion
required string ​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string ​generation
required integer ​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer ​creationTimestamp
required object ​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object ​deletionTimestamp
required object ​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object ​deletionGracePeriodSeconds
required integer ​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer ​labels
required object ​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object ​annotations
required object ​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object ​ownerReferences
required object[] ​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] ​apiVersion
required string ​
API version of the referent.
apiVersion
required string ​kind
required string ​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​name
required string ​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​uid
required string ​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​controller
required boolean ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean ​finalizers
required string[] ​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] ​managedFields
required object[] ​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] ​manager
required string ​
Manager is an identifier of the workflow managing these fields.
manager
required string ​operation
required string ​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string ​apiVersion
required string ​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string ​time
required object ​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object ​fieldsType
required string ​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string ​fieldsV1
required object ​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object ​subresource
required string ​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string ​spec
required object ​
spec
required object ​displayName
required string ​
DisplayName is the name that is shown in the UI
displayName
required string ​description
required string ​
Description describes the virtual cluster template
description
required string ​owner
required object ​
Owner holds the owner of this object
owner
required object ​template
required object ​
Template holds the virtual cluster template
template
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the virtual cluster instance template
instanceTemplate
required object ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​access
required object ​
Access defines the access of users and teams to the virtual cluster.
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​pro
required object ​
Pro defines the pro settings for the virtual cluster
pro
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster is a pro cluster or not
enabled
required boolean ​helmRelease
required object ​
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease
required object ​chart
required object ​
infos about what chart to deploy
chart
required object ​name
required string ​
the name of the helm chart
name
required string ​repo
required string ​
the repo of the helm chart
repo
required string ​username
required string ​
The username that is required for this repository
username
required string ​password
required string ​
The password that is required for this repository
password
required string ​version
required string ​
the version of the helm chart to use
version
required string ​values
required string ​
the values for the given chart
values
required string ​accessPoint
required object ​
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint
required object ​ingress
required object ​
Ingress defines virtual cluster access via ingress
ingress
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires
the connected cluster to have the loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.
enabled
required boolean ​loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.forwardToken
required boolean ​
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken
required boolean ​spaceTemplate
required object ​
SpaceTemplate holds the space template
spaceTemplate
required object ​metadata
required object ​
metadata
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​parameters
required object[] ​
Parameters define additional app parameters that will set helm values
parameters
required object[] ​variable
required string ​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string ​label
required string ​
Label is the label to show for this parameter
label
required string ​description
required string ​
Description is the description to show for this parameter
description
required string ​type
required string ​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] ​min
required integer ​
Min is the minimum number if type is number
min
required integer ​max
required integer ​
Max is the maximum number if type is number
max
required integer ​required
required boolean ​
Required specifies if this parameter is required
required
required boolean ​defaultValue
required string ​
DefaultValue is the default value if none is specified
defaultValue
required string ​placeholder
required string ​
Placeholder shown in the UI
placeholder
required string ​invalidation
required string ​
Invalidation regex that if matched will reject the input
invalidation
required string ​validation
required string ​
Validation regex that if matched will allow the input
validation
required string ​section
required string ​
Section where this app should be displayed. Apps with the same section name will be grouped together
section
required string ​versions
required object[] ​
Versions are different versions of the template that can be referenced as well
versions
required object[] ​template
required object ​
Template holds the space template
template
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the virtual cluster instance template
instanceTemplate
required object ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​access
required object ​
Access defines the access of users and teams to the virtual cluster.
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​pro
required object ​
Pro defines the pro settings for the virtual cluster
pro
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster is a pro cluster or not
enabled
required boolean ​helmRelease
required object ​
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease
required object ​chart
required object ​
infos about what chart to deploy
chart
required object ​name
required string ​
the name of the helm chart
name
required string ​repo
required string ​
the repo of the helm chart
repo
required string ​username
required string ​
The username that is required for this repository
username
required string ​password
required string ​
The password that is required for this repository
password
required string ​version
required string ​
the version of the helm chart to use
version
required string ​values
required string ​
the values for the given chart
values
required string ​accessPoint
required object ​
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint
required object ​ingress
required object ​
Ingress defines virtual cluster access via ingress
ingress
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires
the connected cluster to have the loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.
enabled
required boolean ​loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.forwardToken
required boolean ​
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken
required boolean ​spaceTemplate
required object ​
SpaceTemplate holds the space template
spaceTemplate
required object ​metadata
required object ​
metadata
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​parameters
required object[] ​
Parameters define additional app parameters that will set helm values
parameters
required object[] ​variable
required string ​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string ​label
required string ​
Label is the label to show for this parameter
label
required string ​description
required string ​
Description is the description to show for this parameter
description
required string ​type
required string ​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] ​min
required integer ​
Min is the minimum number if type is number
min
required integer ​max
required integer ​
Max is the maximum number if type is number
max
required integer ​required
required boolean ​
Required specifies if this parameter is required
required
required boolean ​defaultValue
required string ​
DefaultValue is the default value if none is specified
defaultValue
required string ​placeholder
required string ​
Placeholder shown in the UI
placeholder
required string ​invalidation
required string ​
Invalidation regex that if matched will reject the input
invalidation
required string ​validation
required string ​
Validation regex that if matched will allow the input
validation
required string ​section
required string ​
Section where this app should be displayed. Apps with the same section name will be grouped together
section
required string ​version
required string ​
Version is the version. Needs to be in X.X.X format.
version
required string ​access
required object[] ​
Access holds the access rights for users and teams
access
required object[] ​name
required string ​
Name is an optional name that is used for this access rule
name
required string ​verbs
required string[] ​
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
verbs
required string[] ​subresources
required string[] ​
Subresources defines the sub resources that are allowed by this access rule
subresources
required string[] ​users
required string[] ​
Users specifies which users should be able to access this secret with the aforementioned verbs
users
required string[] ​teams
required string[] ​
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams
required string[] ​status
required object ​
status
required object ​apps
required object[] ​
apps
required object[] ​name
required string ​
Name is the kubernetes name of the object
name
required string ​displayName
required string ​
The display name shown in the UI
displayName
required string ​icon
required string ​
Icon is the icon of the user / team
icon
required string ​username
required string ​
The username that is used to login
username
required string ​email
required string ​
The users email address
email
required string ​subject
required string ​
The user subject
subject
required string ​defaultSpaceTemplate
required string ​
DefaultSpaceTemplate
defaultSpaceTemplate
required string ​spaceTemplates
required object[] ​
SpaceTemplates holds all the allowed space templates
spaceTemplates
required object[] ​kind
required string ​
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​apiVersion
required string ​
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion
required string ​metadata
required object ​
metadata
required object ​name
required string ​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​generateName
required string ​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string ​namespace
required string ​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string ​selfLink
required string ​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string ​uid
required string ​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​resourceVersion
required string ​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string ​generation
required integer ​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer ​creationTimestamp
required object ​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object ​deletionTimestamp
required object ​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object ​deletionGracePeriodSeconds
required integer ​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer ​labels
required object ​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object ​annotations
required object ​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object ​ownerReferences
required object[] ​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] ​apiVersion
required string ​
API version of the referent.
apiVersion
required string ​kind
required string ​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​name
required string ​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​uid
required string ​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​controller
required boolean ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean ​finalizers
required string[] ​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] ​managedFields
required object[] ​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] ​manager
required string ​
Manager is an identifier of the workflow managing these fields.
manager
required string ​operation
required string ​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string ​apiVersion
required string ​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string ​time
required object ​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object ​fieldsType
required string ​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string ​fieldsV1
required object ​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object ​subresource
required string ​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string ​spec
required object ​
spec
required object ​displayName
required string ​
DisplayName is the name that is shown in the UI
displayName
required string ​description
required string ​
Description describes the space template
description
required string ​owner
required object ​
Owner holds the owner of this object
owner
required object ​template
required object ​
Template holds the space template
template
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the space instance template
instanceTemplate
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​access
required object ​
The space access
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​parameters
required object[] ​
Parameters define additional app parameters that will set helm values
parameters
required object[] ​variable
required string ​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string ​label
required string ​
Label is the label to show for this parameter
label
required string ​description
required string ​
Description is the description to show for this parameter
description
required string ​type
required string ​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] ​min
required integer ​
Min is the minimum number if type is number
min
required integer ​max
required integer ​
Max is the maximum number if type is number
max
required integer ​required
required boolean ​
Required specifies if this parameter is required
required
required boolean ​defaultValue
required string ​
DefaultValue is the default value if none is specified
defaultValue
required string ​placeholder
required string ​
Placeholder shown in the UI
placeholder
required string ​invalidation
required string ​
Invalidation regex that if matched will reject the input
invalidation
required string ​validation
required string ​
Validation regex that if matched will allow the input
validation
required string ​section
required string ​
Section where this app should be displayed. Apps with the same section name will be grouped together
section
required string ​versions
required object[] ​
Versions are different space template versions that can be referenced as well
versions
required object[] ​template
required object ​
Template holds the space template
template
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the space instance template
instanceTemplate
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​access
required object ​
The space access
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​parameters
required object[] ​
Parameters define additional app parameters that will set helm values
parameters
required object[] ​variable
required string ​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string ​label
required string ​
Label is the label to show for this parameter
label
required string ​description
required string ​
Description is the description to show for this parameter
description
required string ​type
required string ​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] ​min
required integer ​
Min is the minimum number if type is number
min
required integer ​max
required integer ​
Max is the maximum number if type is number
max
required integer ​required
required boolean ​
Required specifies if this parameter is required
required
required boolean ​defaultValue
required string ​
DefaultValue is the default value if none is specified
defaultValue
required string ​placeholder
required string ​
Placeholder shown in the UI
placeholder
required string ​invalidation
required string ​
Invalidation regex that if matched will reject the input
invalidation
required string ​validation
required string ​
Validation regex that if matched will allow the input
validation
required string ​section
required string ​
Section where this app should be displayed. Apps with the same section name will be grouped together
section
required string ​version
required string ​
Version is the version. Needs to be in X.X.X format.
version
required string ​access
required object[] ​
Access holds the access rights for users and teams
access
required object[] ​name
required string ​
Name is an optional name that is used for this access rule
name
required string ​verbs
required string[] ​
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
verbs
required string[] ​subresources
required string[] ​
Subresources defines the sub resources that are allowed by this access rule
subresources
required string[] ​users
required string[] ​
Users specifies which users should be able to access this secret with the aforementioned verbs
users
required string[] ​teams
required string[] ​
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams
required string[] ​status
required object ​
status
required object ​apps
required object[] ​
apps
required object[] ​name
required string ​
Name is the kubernetes name of the object
name
required string ​displayName
required string ​
The display name shown in the UI
displayName
required string ​icon
required string ​
Icon is the icon of the user / team
icon
required string ​username
required string ​
The username that is used to login
username
required string ​email
required string ​
The users email address
email
required string ​subject
required string ​
The user subject
subject
required string ​defaultDevPodWorkspaceTemplate
required string ​
DefaultDevPodWorkspaceTemplate
defaultDevPodWorkspaceTemplate
required string ​devPodWorkspaceTemplates
required object[] ​
DevPodWorkspaceTemplates holds all the allowed space templates
devPodWorkspaceTemplates
required object[] ​kind
required string ​
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​apiVersion
required string ​
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion
required string ​metadata
required object ​
metadata
required object ​name
required string ​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​generateName
required string ​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string ​namespace
required string ​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string ​selfLink
required string ​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string ​uid
required string ​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​resourceVersion
required string ​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string ​generation
required integer ​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer ​creationTimestamp
required object ​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object ​deletionTimestamp
required object ​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object ​deletionGracePeriodSeconds
required integer ​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer ​labels
required object ​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object ​annotations
required object ​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object ​ownerReferences
required object[] ​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] ​apiVersion
required string ​
API version of the referent.
apiVersion
required string ​kind
required string ​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​name
required string ​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​uid
required string ​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​controller
required boolean ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean ​finalizers
required string[] ​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] ​managedFields
required object[] ​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] ​manager
required string ​
Manager is an identifier of the workflow managing these fields.
manager
required string ​operation
required string ​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string ​apiVersion
required string ​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string ​time
required object ​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object ​fieldsType
required string ​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string ​fieldsV1
required object ​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object ​subresource
required string ​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string ​spec
required object ​
spec
required object ​displayName
required string ​
DisplayName is the name that is shown in the UI
displayName
required string ​description
required string ​
Description describes the virtual cluster template
description
required string ​owner
required object ​
Owner holds the owner of this object
owner
required object ​parameters
required object[] ​
Parameters define additional app parameters that will set provider values
parameters
required object[] ​variable
required string ​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string ​label
required string ​
Label is the label to show for this parameter
label
required string ​description
required string ​
Description is the description to show for this parameter
description
required string ​type
required string ​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] ​min
required integer ​
Min is the minimum number if type is number
min
required integer ​max
required integer ​
Max is the maximum number if type is number
max
required integer ​required
required boolean ​
Required specifies if this parameter is required
required
required boolean ​defaultValue
required string ​
DefaultValue is the default value if none is specified
defaultValue
required string ​placeholder
required string ​
Placeholder shown in the UI
placeholder
required string ​invalidation
required string ​
Invalidation regex that if matched will reject the input
invalidation
required string ​validation
required string ​
Validation regex that if matched will allow the input
validation
required string ​section
required string ​
Section where this app should be displayed. Apps with the same section name will be grouped together
section
required string ​template
required object ​
Template holds the DevPod workspace template
template
required object ​kubernetes
required object ​
Kubernetes holds the definition for kubernetes based workspaces
kubernetes
required object ​pod
required object ​
Pod holds the definition for workspace pod.
Defaults will be applied for fields that aren't specified.
pod
required object ​metadata
required object ​
metadata
required object ​spec
required object ​
spec
required object ​volumes
required object[] ​
List of volumes that can be mounted by containers belonging to the pod.
volumes
required object[] ​name
required string ​
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
name
required string ​hostPath
required object ​
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​
TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
mount host directories as read/write.
hostPath
required object ​path
required string ​
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
path
required string ​type
required string ​
type for HostPath Volume
Defaults to ""
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type
required string ​emptyDir
required object ​
emptyDir represents a temporary directory that shares a pod's lifetime.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
emptyDir
required object ​medium
required string ​
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
medium
required string ​sizeLimit
required object ​
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
sizeLimit
required object ​Format
required string ​
Format
required string ​gcePersistentDisk
required object ​
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
gcePersistentDisk
required object ​pdName
required string ​
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
pdName
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​partition
required integer ​
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
partition
required integer ​readOnly
required boolean ​
readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly
required boolean ​awsElasticBlockStore
required object ​
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
awsElasticBlockStore
required object ​volumeID
required string ​
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​partition
required integer ​
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).
partition
required integer ​readOnly
required boolean ​
readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
readOnly
required boolean ​gitRepo
required object ​
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.
gitRepo
required object ​repository
required string ​
repository is the URL
repository
required string ​revision
required string ​
revision is the commit hash for the specified revision.
revision
required string ​directory
required string ​
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.
directory
required string ​secret
required object ​
secret represents a secret that should populate this volume.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
secret
required object ​secretName
required string ​
secretName is the name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
secretName
required string ​items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​defaultMode
required integer ​
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.
defaultMode
required integer ​optional
required boolean ​
optional field specify whether the Secret or its keys must be defined
optional
required boolean ​nfs
required object ​
nfs represents an NFS mount on the host that shares a pod's lifetime
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
nfs
required object ​server
required string ​
server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server
required string ​path
required string ​
path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
path
required string ​readOnly
required boolean ​
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
readOnly
required boolean ​iscsi
required object ​
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
iscsi
required object ​targetPortal
required string ​
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).
targetPortal
required string ​iqn
required string ​
iqn is the target iSCSI Qualified Name.
iqn
required string ​lun
required integer ​
lun represents iSCSI Target Lun number.
lun
required integer ​iscsiInterface
required string ​
iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
iscsiInterface
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​readOnly
required boolean ​
readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
readOnly
required boolean ​portals
required string[] ​
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).
portals
required string[] ​chapAuthDiscovery
required boolean ​
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthDiscovery
required boolean ​chapAuthSession
required boolean ​
chapAuthSession defines whether support iSCSI Session CHAP authentication
chapAuthSession
required boolean ​secretRef
required object ​
secretRef is the CHAP Secret for iSCSI target and initiator authentication
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.initiatorName
required string ​
initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
(target portal):(volume name) will be created for the connection.
initiatorName
required string ​glusterfs
required object ​
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
glusterfs
required object ​endpoints
required string ​
endpoints is the endpoint name that details Glusterfs topology.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
endpoints
required string ​path
required string ​
path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path
required string ​readOnly
required boolean ​
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
readOnly
required boolean ​persistentVolumeClaim
required object ​
persistentVolumeClaimVolumeSource represents a reference to a
PersistentVolumeClaim in the same namespace.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
persistentVolumeClaim
required object ​claimName
required string ​
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
claimName
required string ​readOnly
required boolean ​
readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
readOnly
required boolean ​rbd
required object ​
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
rbd
required object ​monitors
required string[] ​
monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitors
required string[] ​image
required string ​
image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
image
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​pool
required string ​
pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool
required string ​user
required string ​
user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user
required string ​keyring
required string ​
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
keyring
required string ​secretRef
required object ​
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
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean ​
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
readOnly
required boolean ​flexVolume
required object ​
flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
flexVolume
required object ​driver
required string ​
driver is the name of the driver to use for this volume.
driver
required string ​fsType
required string ​
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.
fsType
required string ​secretRef
required object ​
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.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean ​
readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​options
required object ​
options is Optional: this field holds extra command options if any.
options
required object ​cinder
required object ​
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
cinder
required object ​volumeID
required string ​
volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md
volumeID
required string ​fsType
required string ​
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
fsType
required string ​readOnly
required boolean ​
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
readOnly
required boolean ​secretRef
required object ​
secretRef is optional: points to a secret object containing parameters used to connect
to OpenStack.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.cephfs
required object ​
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.
cephfs
required object ​monitors
required string[] ​
monitors is Required: Monitors is a collection of Ceph monitors
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
monitors
required string[] ​path
required string ​
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
path
required string ​user
required string ​
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
user
required string ​secretFile
required string ​
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
secretFile
required string ​secretRef
required object ​
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
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean ​
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
readOnly
required boolean ​flocker
required object ​
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.
flocker
required object ​downwardAPI
required object ​
downwardAPI represents downward API about the pod that should populate this volume
downwardAPI
required object ​items
required object[] ​
Items is a list of downward API volume file
items
required object[] ​path
required string ​
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 '..'
path
required string ​fieldRef
required object ​
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
fieldRef
required object ​resourceFieldRef
required object ​
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
resourceFieldRef
required object ​mode
required integer ​
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.
mode
required integer ​defaultMode
required integer ​
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.
defaultMode
required integer ​fc
required object ​
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
fc
required object ​targetWWNs
required string[] ​
targetWWNs is Optional: FC target worldwide names (WWNs)
targetWWNs
required string[] ​lun
required integer ​
lun is Optional: FC target lun number
lun
required integer ​fsType
required string ​
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.
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​readOnly
required boolean ​
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​wwids
required string[] ​
wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
wwids
required string[] ​azureFile
required object ​
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.
azureFile
required object ​secretName
required string ​
secretName is the name of secret that contains Azure Storage Account Name and Key
secretName
required string ​shareName
required string ​
shareName is the azure share Name
shareName
required string ​readOnly
required boolean ​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​configMap
required object ​
configMap represents a configMap that should populate this volume
configMap
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​defaultMode
required integer ​
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.
defaultMode
required integer ​optional
required boolean ​
optional specify whether the ConfigMap or its keys must be defined
optional
required boolean ​vsphereVolume
required object ​
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.
vsphereVolume
required object ​volumePath
required string ​
volumePath is the path that identifies vSphere volume vmdk
volumePath
required string ​fsType
required string ​
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.
fsType
required string ​storagePolicyName
required string ​
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
storagePolicyName
required string ​storagePolicyID
required string ​
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyID
required string ​quobyte
required object ​
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.
quobyte
required object ​registry
required string ​
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
registry
required string ​volume
required string ​
volume is a string that references an already created Quobyte volume by name.
volume
required string ​readOnly
required boolean ​
readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
readOnly
required boolean ​user
required string ​
user to map volume access to
Defaults to serivceaccount user
user
required string ​group
required string ​
group to map volume access to
Default is no group
group
required string ​tenant
required string ​
tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
tenant
required string ​azureDisk
required object ​
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.
azureDisk
required object ​diskName
required string ​
diskName is the Name of the data disk in the blob storage
diskName
required string ​diskURI
required string ​
diskURI is the URI of data disk in the blob storage
diskURI
required string ​cachingMode
required string ​
cachingMode is the Host Caching mode: None, Read Only, Read Write.
cachingMode
required string ​fsType
required string ​
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.
fsType
required string ​readOnly
required boolean ​
readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​kind
required string ​
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
kind
required string ​photonPersistentDisk
required object ​
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.
photonPersistentDisk
required object ​projected
required object ​
projected items for all in one resources secrets, configmaps, and downward API
projected
required object ​sources
required object[] ​
sources is the list of volume projections. Each entry in this list
handles one source.
sources
required object[] ​secret
required object ​
secret information about the secret data to project
secret
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​optional
required boolean ​
optional field specify whether the Secret or its key must be defined
optional
required boolean ​downwardAPI
required object ​
downwardAPI information about the downwardAPI data to project
downwardAPI
required object ​items
required object[] ​
Items is a list of DownwardAPIVolume file
items
required object[] ​path
required string ​
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 '..'
path
required string ​fieldRef
required object ​
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
fieldRef
required object ​resourceFieldRef
required object ​
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
resourceFieldRef
required object ​mode
required integer ​
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.
mode
required integer ​configMap
required object ​
configMap information about the configMap data to project
configMap
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​optional
required boolean ​
optional specify whether the ConfigMap or its keys must be defined
optional
required boolean ​serviceAccountToken
required object ​
serviceAccountToken is information about the serviceAccountToken data to project
serviceAccountToken
required object ​audience
required string ​
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.
audience
required string ​expirationSeconds
required integer ​
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.
expirationSeconds
required integer ​path
required string ​
path is the path relative to the mount point of the file to project the
token into.
path
required string ​clusterTrustBundle
required object ​
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.
clusterTrustBundle
required object ​.spec.trustBundle
field
of ClusterTrustBundle objects in an auto-updating file.name
required string ​
Select a single ClusterTrustBundle by object name. Mutually-exclusive
with signerName and labelSelector.
name
required string ​signerName
required string ​
Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated.
signerName
required string ​labelSelector
required object ​
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".
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​optional
required boolean ​
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.
optional
required boolean ​path
required string ​
Relative path from the volume root to write the bundle.
path
required string ​defaultMode
required integer ​
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.
defaultMode
required integer ​portworxVolume
required object ​
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.
portworxVolume
required object ​volumeID
required string ​
volumeID uniquely identifies a Portworx volume
volumeID
required string ​fsType
required string ​
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.
fsType
required string ​readOnly
required boolean ​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​scaleIO
required object ​
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.
scaleIO
required object ​gateway
required string ​
gateway is the host address of the ScaleIO API Gateway.
gateway
required string ​system
required string ​
system is the name of the storage system as configured in ScaleIO.
system
required string ​secretRef
required object ​
secretRef references to the secret for ScaleIO user and other
sensitive information. If this is not provided, Login operation will fail.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.sslEnabled
required boolean ​
sslEnabled Flag enable/disable SSL communication with Gateway, default false
sslEnabled
required boolean ​protectionDomain
required string ​
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
protectionDomain
required string ​storagePool
required string ​
storagePool is the ScaleIO Storage Pool associated with the protection domain.
storagePool
required string ​storageMode
required string ​
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
storageMode
required string ​volumeName
required string ​
volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source.
volumeName
required string ​fsType
required string ​
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".
fsType
required string ​readOnly
required boolean ​
readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​storageos
required object ​
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.
storageos
required object ​volumeName
required string ​
volumeName is the human-readable name of the StorageOS volume. Volume
names are only unique within a namespace.
volumeName
required string ​volumeNamespace
required string ​
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.
volumeNamespace
required string ​fsType
required string ​
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.
fsType
required string ​readOnly
required boolean ​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​secretRef
required object ​
secretRef specifies the secret to use for obtaining the StorageOS API
credentials. If not specified, default values will be attempted.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.csi
required object ​
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
csi
required object ​driver
required string ​
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.
driver
required string ​readOnly
required boolean ​
readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
readOnly
required boolean ​fsType
required string ​
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.
fsType
required string ​volumeAttributes
required object ​
volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
volumeAttributes
required object ​nodePublishSecretRef
required object ​
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.
nodePublishSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.ephemeral
required object ​
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.
ephemeral
required object ​volumeClaimTemplate
required object ​
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.
volumeClaimTemplate
required object ​(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).metadata
required object ​
metadata
required object ​name
required string ​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​generateName
required string ​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string ​namespace
required string ​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string ​selfLink
required string ​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string ​uid
required string ​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​resourceVersion
required string ​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string ​generation
required integer ​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer ​creationTimestamp
required object ​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object ​deletionTimestamp
required object ​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object ​deletionGracePeriodSeconds
required integer ​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer ​labels
required object ​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object ​annotations
required object ​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object ​ownerReferences
required object[] ​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] ​apiVersion
required string ​
API version of the referent.
apiVersion
required string ​kind
required string ​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​name
required string ​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​uid
required string ​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​controller
required boolean ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean ​finalizers
required string[] ​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] ​managedFields
required object[] ​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] ​manager
required string ​
Manager is an identifier of the workflow managing these fields.
manager
required string ​operation
required string ​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string ​apiVersion
required string ​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string ​time
required object ​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object ​fieldsType
required string ​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string ​fieldsV1
required object ​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object ​subresource
required string ​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string ​spec
required object ​
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
required object ​accessModes
required string[] ​
accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
accessModes
required string[] ​selector
required object ​
selector is a label query over volumes to consider for binding.
selector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​resources
required object ​
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
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
limits
required object ​requests
required object ​
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/
requests
required object ​volumeName
required string ​
volumeName is the binding reference to the PersistentVolume backing this claim.
volumeName
required string ​storageClassName
required string ​
storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
storageClassName
required string ​volumeMode
required string ​
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
volumeMode
required string ​dataSource
required object ​
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.
dataSource
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​dataSourceRef
required object ​
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.
dataSourceRef
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​namespace
required string ​
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.
namespace
required string ​volumeAttributesClassName
required string ​
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).
volumeAttributesClassName
required string ​image
required object ​
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).
The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
image
required object ​reference
required string ​
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.
reference
required string ​pullPolicy
required string ​
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.
pullPolicy
required string ​initContainers
required object[] ​
List of initialization containers belonging to the pod.
initContainers
required object[] ​name
required string ​
Name of the container specified as a DNS_LABEL.
name
required string ​image
required string ​
Container image name.
image
required string ​command
required string[] ​
Entrypoint array. Not executed within a shell.
command
required string[] ​args
required string[] ​
Arguments to the entrypoint.
args
required string[] ​workingDir
required string ​
Container's working directory.
workingDir
required string ​ports
required object[] ​
List of ports to expose from the container. Not specifying a port here
ports
required object[] ​name
required string ​
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.
name
required string ​hostPort
required integer ​
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.
hostPort
required integer ​containerPort
required integer ​
Number of port to expose on the pod's IP address.
This must be a valid port number, 0 ( x ( 65536.
containerPort
required integer ​protocol
required string ​
Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP".
protocol
required string ​hostIP
required string ​
What host IP to bind the external port to.
hostIP
required string ​envFrom
required object[] ​
envFrom
required object[] ​prefix
required string ​
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
prefix
required string ​configMapRef
required object ​
The ConfigMap to select from
configMapRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the ConfigMap must be defined
optional
required boolean ​secretRef
required object ​
The Secret to select from
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the Secret must be defined
optional
required boolean ​env
required object[] ​
List of environment variables to set in the container.
env
required object[] ​name
required string ​
Name of the environment variable. Must be a C_IDENTIFIER.
name
required string ​value
required string ​
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 "".
value
required string ​valueFrom
required object ​
Source for the environment variable's value. Cannot be used if value is not empty.
valueFrom
required object ​fieldRef
required object ​
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.
fieldRef
required object ​metadata.labels['(KEY)']
, metadata.annotations['(KEY)']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.resourceFieldRef
required object ​
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.
resourceFieldRef
required object ​configMapKeyRef
required object ​
Selects a key of a ConfigMap.
configMapKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key to select.
key
required string ​optional
required boolean ​
Specify whether the ConfigMap or its key must be defined
optional
required boolean ​secretKeyRef
required object ​
Selects a key of a secret in the pod's namespace
secretKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​resources
required object ​
Compute Resources required by this container.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​resizePolicy
required object[] ​
Resources resize policy for the container.
resizePolicy
required object[] ​restartPolicy
required string ​
RestartPolicy defines the restart behavior of individual containers in a pod.
restartPolicy
required string ​volumeMounts
required object[] ​
Pod volumes to mount into the container's filesystem.
volumeMounts
required object[] ​name
required string ​
This must match the Name of a Volume.
name
required string ​readOnly
required boolean ​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean ​recursiveReadOnly
required string ​
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.
recursiveReadOnly
required string ​mountPath
required string ​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string ​subPath
required string ​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string ​mountPropagation
required string ​
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).
mountPropagation
required string ​subPathExpr
required string ​
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.
subPathExpr
required string ​volumeDevices
required object[] ​
volumeDevices is the list of block devices to be used by the container.
volumeDevices
required object[] ​livenessProbe
required object ​
Periodic probe of container liveness.
livenessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​readinessProbe
required object ​
Periodic probe of container service readiness.
readinessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​startupProbe
required object ​
StartupProbe indicates that the Pod has successfully initialized.
startupProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​lifecycle
required object ​
Actions that the management system should take in response to container lifecycle events.
lifecycle
required object ​postStart
required object ​
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
postStart
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​preStop
required object ​
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
preStop
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​terminationMessagePath
required string ​
Optional: Path at which the file to which the container's termination message
terminationMessagePath
required string ​terminationMessagePolicy
required string ​
Indicate how the termination message should be populated. File will use the contents of
terminationMessagePolicy
required string ​imagePullPolicy
required string ​
Image pull policy.
imagePullPolicy
required string ​securityContext
required object ​
SecurityContext defines the security options the container should be run with.
securityContext
required object ​capabilities
required object ​
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.
capabilities
required object ​privileged
required boolean ​
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.
privileged
required boolean ​seLinuxOptions
required object ​
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.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
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.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
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.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
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.
runAsUserName
required string ​hostProcess
required boolean ​
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.
hostProcess
required boolean ​runAsUser
required integer ​
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.
runAsUser
required integer ​runAsGroup
required integer ​
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.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
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.
runAsNonRoot
required boolean ​readOnlyRootFilesystem
required boolean ​
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.
readOnlyRootFilesystem
required boolean ​allowPrivilegeEscalation
required boolean ​
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:
- run as Privileged
- has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
allowPrivilegeEscalation
required boolean ​procMount
required string ​
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.
procMount
required string ​seccompProfile
required object ​
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.
seccompProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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.
localhostProfile
required string ​appArmorProfile
required object ​
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.
appArmorProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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".
localhostProfile
required string ​stdin
required boolean ​
Whether this container should allocate a buffer for stdin in the container runtime.
stdin
required boolean ​stdinOnce
required boolean ​
StdinOnce default is false
stdinOnce
required boolean ​tty
required boolean ​
TTY default is false.
tty
required boolean ​containers
required object[] ​
List of containers belonging to the pod.
containers
required object[] ​name
required string ​
Name of the container specified as a DNS_LABEL.
name
required string ​image
required string ​
Container image name.
image
required string ​command
required string[] ​
Entrypoint array. Not executed within a shell.
command
required string[] ​args
required string[] ​
Arguments to the entrypoint.
args
required string[] ​workingDir
required string ​
Container's working directory.
workingDir
required string ​ports
required object[] ​
List of ports to expose from the container. Not specifying a port here
ports
required object[] ​name
required string ​
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.
name
required string ​hostPort
required integer ​
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.
hostPort
required integer ​containerPort
required integer ​
Number of port to expose on the pod's IP address.
This must be a valid port number, 0 ( x ( 65536.
containerPort
required integer ​protocol
required string ​
Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP".
protocol
required string ​hostIP
required string ​
What host IP to bind the external port to.
hostIP
required string ​envFrom
required object[] ​
envFrom
required object[] ​prefix
required string ​
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
prefix
required string ​configMapRef
required object ​
The ConfigMap to select from
configMapRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the ConfigMap must be defined
optional
required boolean ​secretRef
required object ​
The Secret to select from
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the Secret must be defined
optional
required boolean ​env
required object[] ​
List of environment variables to set in the container.
env
required object[] ​name
required string ​
Name of the environment variable. Must be a C_IDENTIFIER.
name
required string ​value
required string ​
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 "".
value
required string ​valueFrom
required object ​
Source for the environment variable's value. Cannot be used if value is not empty.
valueFrom
required object ​fieldRef
required object ​
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.
fieldRef
required object ​metadata.labels['(KEY)']
, metadata.annotations['(KEY)']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.resourceFieldRef
required object ​
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.
resourceFieldRef
required object ​configMapKeyRef
required object ​
Selects a key of a ConfigMap.
configMapKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key to select.
key
required string ​optional
required boolean ​
Specify whether the ConfigMap or its key must be defined
optional
required boolean ​secretKeyRef
required object ​
Selects a key of a secret in the pod's namespace
secretKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​resources
required object ​
Compute Resources required by this container.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​resizePolicy
required object[] ​
Resources resize policy for the container.
resizePolicy
required object[] ​restartPolicy
required string ​
RestartPolicy defines the restart behavior of individual containers in a pod.
restartPolicy
required string ​volumeMounts
required object[] ​
Pod volumes to mount into the container's filesystem.
volumeMounts
required object[] ​name
required string ​
This must match the Name of a Volume.
name
required string ​readOnly
required boolean ​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean ​recursiveReadOnly
required string ​
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.
recursiveReadOnly
required string ​mountPath
required string ​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string ​subPath
required string ​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string ​mountPropagation
required string ​
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).
mountPropagation
required string ​subPathExpr
required string ​
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.
subPathExpr
required string ​volumeDevices
required object[] ​
volumeDevices is the list of block devices to be used by the container.
volumeDevices
required object[] ​livenessProbe
required object ​
Periodic probe of container liveness.
livenessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​readinessProbe
required object ​
Periodic probe of container service readiness.
readinessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​startupProbe
required object ​
StartupProbe indicates that the Pod has successfully initialized.
startupProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​lifecycle
required object ​
Actions that the management system should take in response to container lifecycle events.
lifecycle
required object ​postStart
required object ​
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
postStart
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​preStop
required object ​
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
preStop
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​terminationMessagePath
required string ​
Optional: Path at which the file to which the container's termination message
terminationMessagePath
required string ​terminationMessagePolicy
required string ​
Indicate how the termination message should be populated. File will use the contents of
terminationMessagePolicy
required string ​imagePullPolicy
required string ​
Image pull policy.
imagePullPolicy
required string ​securityContext
required object ​
SecurityContext defines the security options the container should be run with.
securityContext
required object ​capabilities
required object ​
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.
capabilities
required object ​privileged
required boolean ​
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.
privileged
required boolean ​seLinuxOptions
required object ​
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.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
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.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
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.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
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.
runAsUserName
required string ​hostProcess
required boolean ​
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.
hostProcess
required boolean ​runAsUser
required integer ​
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.
runAsUser
required integer ​runAsGroup
required integer ​
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.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
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.
runAsNonRoot
required boolean ​readOnlyRootFilesystem
required boolean ​
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.
readOnlyRootFilesystem
required boolean ​allowPrivilegeEscalation
required boolean ​
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:
- run as Privileged
- has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
allowPrivilegeEscalation
required boolean ​procMount
required string ​
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.
procMount
required string ​seccompProfile
required object ​
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.
seccompProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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.
localhostProfile
required string ​appArmorProfile
required object ​
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.
appArmorProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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".
localhostProfile
required string ​stdin
required boolean ​
Whether this container should allocate a buffer for stdin in the container runtime.
stdin
required boolean ​stdinOnce
required boolean ​
StdinOnce default is false
stdinOnce
required boolean ​tty
required boolean ​
TTY default is false.
tty
required boolean ​restartPolicy
required string ​
Restart policy for all containers within the pod.
restartPolicy
required string ​terminationGracePeriodSeconds
required integer ​
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
terminationGracePeriodSeconds
required integer ​activeDeadlineSeconds
required integer ​
Optional duration in seconds the pod may be active on the node relative to
activeDeadlineSeconds
required integer ​dnsPolicy
required string ​
Set DNS policy for the pod.
dnsPolicy
required string ​nodeSelector
required object ​
NodeSelector is a selector which must be true for the pod to fit on a node.
nodeSelector
required object ​serviceAccountName
required string ​
ServiceAccountName is the name of the ServiceAccount to use to run this pod.
serviceAccountName
required string ​automountServiceAccountToken
required boolean ​
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
automountServiceAccountToken
required boolean ​nodeName
required string ​
NodeName indicates in which node this pod is scheduled.
nodeName
required string ​hostNetwork
required boolean ​
Host networking requested for this pod. Use the host's network namespace.
hostNetwork
required boolean ​hostPID
required boolean ​
Use the host's pid namespace.
hostPID
required boolean ​hostIPC
required boolean ​
Use the host's ipc namespace.
hostIPC
required boolean ​shareProcessNamespace
required boolean ​
Share a single process namespace between all of the containers in a pod.
shareProcessNamespace
required boolean ​securityContext
required object ​
SecurityContext holds pod-level security attributes and common container settings.
securityContext
required object ​seLinuxOptions
required object ​
The SELinux context to be applied to all containers.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in SecurityContext. If set in
both SecurityContext and PodSecurityContext, the value specified in SecurityContext
takes precedence for that container.
Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
The Windows specific settings applied to all containers.
If unspecified, the options within a container's SecurityContext 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.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
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.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
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.
runAsUserName
required string ​hostProcess
required boolean ​
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.
hostProcess
required boolean ​runAsUser
required integer ​
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsUser
required integer ​runAsGroup
required integer ​
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
required boolean ​supplementalGroups
required integer[] ​
A list of groups applied to the first process run in each container, in
addition to the container's primary GID and fsGroup (if specified). If
the SupplementalGroupsPolicy feature is enabled, the
supplementalGroupsPolicy field determines whether these are in addition
to or instead of any group memberships defined in the container image.
If unspecified, no additional groups are added, though group memberships
defined in the container image may still be used, depending on the
supplementalGroupsPolicy field.
Note that this field cannot be set when spec.os.name is windows.
supplementalGroups
required integer[] ​supplementalGroupsPolicy
required string ​
Defines how supplemental groups of the first container processes are calculated.
Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
and the container runtime must implement support for this feature.
Note that this field cannot be set when spec.os.name is windows.
TODO: update the default value to "Merge" when spec.os.name is not windows in v1.34
supplementalGroupsPolicy
required string ​fsGroup
required integer ​
A special supplemental group that applies to all containers in a pod.
Some volume types allow the Kubelet to change the ownership of that volume
to be owned by the pod:
- The owning GID will be the FSGroup
- The setgid bit is set (new files created in the volume will be owned by FSGroup)
- The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume.
Note that this field cannot be set when spec.os.name is windows.
fsGroup
required integer ​sysctls
required object[] ​
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Note that this field cannot be set when spec.os.name is windows.
sysctls
required object[] ​fsGroupChangePolicy
required string ​
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
before being exposed inside Pod. This field will only apply to
volume types which support fsGroup based ownership(and permissions).
It will have no effect on ephemeral volume types such as: secret, configmaps
and emptydir.
Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
Note that this field cannot be set when spec.os.name is windows.
fsGroupChangePolicy
required string ​seccompProfile
required object ​
The seccomp options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
seccompProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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.
localhostProfile
required string ​appArmorProfile
required object ​
appArmorProfile is the AppArmor options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
appArmorProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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".
localhostProfile
required string ​seLinuxChangePolicy
required string ​
seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime.
This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with -o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
Note that this field cannot be set when spec.os.name is windows.
seLinuxChangePolicy
required string ​-o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.imagePullSecrets
required object[] ​
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
imagePullSecrets
required object[] ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.hostname
required string ​
Specifies the hostname of the Pod
hostname
required string ​subdomain
required string ​
If specified, the fully qualified Pod hostname will be "(hostname).(subdomain).(pod namespace).svc.(cluster domain)".
subdomain
required string ​affinity
required object ​
If specified, the pod's scheduling constraints
affinity
required object ​nodeAffinity
required object ​
Describes node affinity scheduling rules for the pod.
nodeAffinity
required object ​requiredDuringSchedulingIgnoredDuringExecution
required object ​
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.
requiredDuringSchedulingIgnoredDuringExecution
required object ​nodeSelectorTerms
required object[] ​
Required. A list of node selector terms. The terms are ORed.
nodeSelectorTerms
required object[] ​matchExpressions
required object[] ​
A list of node selector requirements by node's labels.
matchExpressions
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchFields
required object[] ​
A list of node selector requirements by node's fields.
matchFields
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​preferredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
preferredDuringSchedulingIgnoredDuringExecution
required object[] ​weight
required integer ​
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
weight
required integer ​preference
required object ​
A node selector term, associated with the corresponding weight.
preference
required object ​matchExpressions
required object[] ​
A list of node selector requirements by node's labels.
matchExpressions
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchFields
required object[] ​
A list of node selector requirements by node's fields.
matchFields
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​podAffinity
required object ​
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAffinity
required object ​requiredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
requiredDuringSchedulingIgnoredDuringExecution
required object[] ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).preferredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
preferredDuringSchedulingIgnoredDuringExecution
required object[] ​weight
required integer ​
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
weight
required integer ​podAffinityTerm
required object ​
Required. A pod affinity term, associated with the corresponding weight.
podAffinityTerm
required object ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).podAntiAffinity
required object ​
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity
required object ​requiredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
requiredDuringSchedulingIgnoredDuringExecution
required object[] ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).preferredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
preferredDuringSchedulingIgnoredDuringExecution
required object[] ​weight
required integer ​
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
weight
required integer ​podAffinityTerm
required object ​
Required. A pod affinity term, associated with the corresponding weight.
podAffinityTerm
required object ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).schedulerName
required string ​
If specified, the pod will be dispatched by specified scheduler.
If not specified, the pod will be dispatched by default scheduler.
schedulerName
required string ​tolerations
required object[] ​
If specified, the pod's tolerations.
tolerations
required object[] ​key
required string ​
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.
key
required string ​operator
required string ​
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.
operator
required string ​value
required string ​
Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
value
required string ​effect
required string ​
Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
effect
required string ​tolerationSeconds
required integer ​
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.
tolerationSeconds
required integer ​hostAliases
required object[] ​
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts
hostAliases
required object[] ​priorityClassName
required string ​
If specified, indicates the pod's priority.
priorityClassName
required string ​priority
required integer ​
priority
required integer ​dnsConfig
required object ​
Specifies the DNS parameters of a pod.
dnsConfig
required object ​nameservers
required string[] ​
A list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.
Duplicated nameservers will be removed.
nameservers
required string[] ​searches
required string[] ​
A list of DNS search domains for host-name lookup.
This will be appended to the base search paths generated from DNSPolicy.
Duplicated search paths will be removed.
searches
required string[] ​options
required object[] ​
A list of DNS resolver options.
This will be merged with the base options generated from DNSPolicy.
Duplicated entries will be removed. Resolution options given in Options
will override those that appear in the base DNSPolicy.
options
required object[] ​readinessGates
required object[] ​
If specified, all readiness gates will be evaluated for pod readiness.
readinessGates
required object[] ​conditionType
required string ​
ConditionType refers to a condition in the pod's condition list with matching type.
conditionType
required string ​runtimeClassName
required string ​
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod
runtimeClassName
required string ​enableServiceLinks
required boolean ​
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
enableServiceLinks
required boolean ​preemptionPolicy
required string ​
PreemptionPolicy is the Policy for preempting pods with lower priority.
preemptionPolicy
required string ​overhead
required object ​
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
overhead
required object ​topologySpreadConstraints
required object[] ​
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.
topologySpreadConstraints
required object[] ​maxSkew
required integer ​
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.
maxSkew
required integer ​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 |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.topologyKey
required string ​
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.
topologyKey
required string ​whenUnsatisfiable
required string ​
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.
whenUnsatisfiable
required string ​labelSelector
required object ​
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.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​minDomains
required integer ​
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.
minDomains
required integer ​nodeAffinityPolicy
required string ​
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.
This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
nodeAffinityPolicy
required string ​nodeTaintsPolicy
required string ​
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.
This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
nodeTaintsPolicy
required string ​matchLabelKeys
required string[] ​
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).
matchLabelKeys
required string[] ​setHostnameAsFQDN
required boolean ​
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).
In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).
In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN.
setHostnameAsFQDN
required boolean ​os
required object ​
Specifies the OS of the containers in the pod.
os
required object ​name
required string ​
Name is the name of the operating system. The currently supported values are linux and windows.
Additional value may be defined in future and can be one of:
https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration
Clients should expect to handle additional values and treat unrecognized values in this field as os: null
name
required string ​hostUsers
required boolean ​
Use the host's user namespace.
hostUsers
required boolean ​schedulingGates
required object[] ​
SchedulingGates is an opaque list of values that if specified will block scheduling the pod.
If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the
scheduler will not attempt to schedule the pod.
schedulingGates
required object[] ​name
required string ​
Name of the scheduling gate.
Each scheduling gate must have a unique name field.
name
required string ​resourceClaims
required object[] ​
ResourceClaims defines which ResourceClaims must be allocated
and reserved before the Pod is allowed to start. The resources
will be made available to those containers which consume them
by name.
resourceClaims
required object[] ​name
required string ​
Name uniquely identifies this resource claim inside the pod.
This must be a DNS_LABEL.
name
required string ​resourceClaimName
required string ​
ResourceClaimName is the name of a ResourceClaim object in the same
namespace as this pod.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must
be set.
resourceClaimName
required string ​resourceClaimTemplateName
required string ​
ResourceClaimTemplateName is the name of a ResourceClaimTemplate
object in the same namespace as this pod.
The template will be used to create a new ResourceClaim, which will
be bound to this pod. When this pod is deleted, the ResourceClaim
will also be deleted. The pod name and resource name, along with a
generated component, will be used to form a unique name for the
ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.
This field is immutable and no changes will be made to the
corresponding ResourceClaim by the control plane after creating the
ResourceClaim.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must
be set.
resourceClaimTemplateName
required string ​resources
required object ​
Resources is the total amount of CPU and Memory resources required by all
containers in the pod. It supports specifying Requests and Limits for
"cpu" and "memory" resource names only. ResourceClaims are not supported.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​volumeClaim
required object ​
VolumeClaim holds the definition for the main workspace persistent volume.
This volume is guaranteed to exist for the lifespan of the workspace.
Defaults will be applied for fields that aren't specified.
volumeClaim
required object ​metadata
required object ​
metadata
required object ​spec
required object ​
spec
required object ​accessModes
required string[] ​
accessModes contains the desired access modes the volume should have.
accessModes
required string[] ​selector
required object ​
selector is a label query over volumes to consider for binding.
selector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​resources
required object ​
resources represents the minimum resources the volume should have.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​volumeName
required string ​
volumeName is the binding reference to the PersistentVolume backing this claim.
volumeName
required string ​storageClassName
required string ​
storageClassName is the name of the StorageClass required by the claim.
storageClassName
required string ​volumeMode
required string ​
volumeMode defines what type of volume is required by the claim.
volumeMode
required string ​dataSource
required object ​
dataSource field can be used to specify either:
dataSource
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​dataSourceRef
required object ​
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
dataSourceRef
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​namespace
required string ​
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.
namespace
required string ​volumeAttributesClassName
required string ​
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
volumeAttributesClassName
required string ​podTimeout
required string ​
PodTimeout specifies a maximum duration to wait for the workspace pod to start up before failing.
Default: 10m
podTimeout
required string ​nodeArchitecture
required string ​
NodeArchitecture specifies the node architecture the workspace image will be built for.
Only necessary if you need to build workspace images on the fly in the kubernetes cluster and your cluster is mixed architecture.
nodeArchitecture
required string ​spaceTemplateRef
required object ​
SpaceTemplateRef is a reference to the space that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
spaceTemplateRef
required object ​name
required string ​
Name holds the name of the template to reference.
name
required string ​version
required string ​
Version holds the template version to use. Version is expected to
be in semantic versioning format. Alternatively, you can also exchange
major, minor or patch with an 'x' to tell Loft to automatically select
the latest major, minor or patch version.
version
required string ​syncOnce
required boolean ​
SyncOnce tells the controller to sync the instance once with the template.
This is useful if you want to sync an instance after a template was changed.
To automatically sync an instance with a template, use 'x.x.x' as version
instead.
syncOnce
required boolean ​spaceTemplate
required object ​
SpaceTemplate is the inline template for a space that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
spaceTemplate
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the space instance template
instanceTemplate
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​access
required object ​
The space access
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​virtualClusterTemplateRef
required object ​
VirtualClusterTemplateRef is a reference to the virtual cluster that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
virtualClusterTemplateRef
required object ​name
required string ​
Name holds the name of the template to reference.
name
required string ​version
required string ​
Version holds the template version to use. Version is expected to
be in semantic versioning format. Alternatively, you can also exchange
major, minor or patch with an 'x' to tell Loft to automatically select
the latest major, minor or patch version.
version
required string ​syncOnce
required boolean ​
SyncOnce tells the controller to sync the instance once with the template.
This is useful if you want to sync an instance after a template was changed.
To automatically sync an instance with a template, use 'x.x.x' as version
instead.
syncOnce
required boolean ​virtualClusterTemplate
required object ​
VirtualClusterTemplate is the inline template for a virtual cluster that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
virtualClusterTemplate
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the virtual cluster instance template
instanceTemplate
required object ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​access
required object ​
Access defines the access of users and teams to the virtual cluster.
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​pro
required object ​
Pro defines the pro settings for the virtual cluster
pro
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster is a pro cluster or not
enabled
required boolean ​helmRelease
required object ​
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease
required object ​chart
required object ​
infos about what chart to deploy
chart
required object ​name
required string ​
the name of the helm chart
name
required string ​repo
required string ​
the repo of the helm chart
repo
required string ​username
required string ​
The username that is required for this repository
username
required string ​password
required string ​
The password that is required for this repository
password
required string ​version
required string ​
the version of the helm chart to use
version
required string ​values
required string ​
the values for the given chart
values
required string ​accessPoint
required object ​
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint
required object ​ingress
required object ​
Ingress defines virtual cluster access via ingress
ingress
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires
the connected cluster to have the loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.
enabled
required boolean ​loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.forwardToken
required boolean ​
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken
required boolean ​spaceTemplate
required object ​
SpaceTemplate holds the space template
spaceTemplate
required object ​metadata
required object ​
metadata
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​workspaceEnv
required {key: object} ​
WorkspaceEnv are environment variables that should be available within the created workspace.
workspaceEnv
required {key: object} ​value
required string ​
Value of this option.
value
required string ​valueFrom
required object ​
ValueFrom specifies a secret where this value should be taken from.
valueFrom
required object ​projectSecretRef
required object ​
ProjectSecretRef is the project secret to use for this value.
projectSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​sharedSecretRef
required object ​
SharedSecretRef is the shared secret to use for this value.
sharedSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​instanceTemplate
required object ​
InstanceTemplate holds the workspace instance template
instanceTemplate
required object ​credentialForwarding
required object ​
CredentialForwarding specifies controls for how workspaces created by this template forward credentials into the workspace
credentialForwarding
required object ​provider
required object ​
Provider holds the legacy VM provider configuration
provider
required object ​name
required string ​
Name is the name of the provider. This can also be an url.
name
required string ​options
required {key: object} ​
Options are the provider option values
options
required {key: object} ​value
required string ​
Value of this option.
value
required string ​valueFrom
required object ​
ValueFrom specifies a secret where this value should be taken from.
valueFrom
required object ​projectSecretRef
required object ​
ProjectSecretRef is the project secret to use for this value.
projectSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​sharedSecretRef
required object ​
SharedSecretRef is the shared secret to use for this value.
sharedSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​env
required {key: object} ​
Env are environment options to set when using the provider.
env
required {key: object} ​value
required string ​
Value of this option.
value
required string ​valueFrom
required object ​
ValueFrom specifies a secret where this value should be taken from.
valueFrom
required object ​projectSecretRef
required object ​
ProjectSecretRef is the project secret to use for this value.
projectSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​sharedSecretRef
required object ​
SharedSecretRef is the shared secret to use for this value.
sharedSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​versions
required object[] ​
Versions are different versions of the template that can be referenced as well
versions
required object[] ​template
required object ​
Template holds the DevPod template
template
required object ​kubernetes
required object ​
Kubernetes holds the definition for kubernetes based workspaces
kubernetes
required object ​pod
required object ​
Pod holds the definition for workspace pod.
Defaults will be applied for fields that aren't specified.
pod
required object ​metadata
required object ​
metadata
required object ​spec
required object ​
spec
required object ​volumes
required object[] ​
List of volumes that can be mounted by containers belonging to the pod.
volumes
required object[] ​name
required string ​
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
name
required string ​hostPath
required object ​
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​
TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
mount host directories as read/write.
hostPath
required object ​path
required string ​
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
path
required string ​type
required string ​
type for HostPath Volume
Defaults to ""
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type
required string ​emptyDir
required object ​
emptyDir represents a temporary directory that shares a pod's lifetime.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
emptyDir
required object ​medium
required string ​
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
medium
required string ​sizeLimit
required object ​
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
sizeLimit
required object ​Format
required string ​
Format
required string ​gcePersistentDisk
required object ​
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
gcePersistentDisk
required object ​pdName
required string ​
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
pdName
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​partition
required integer ​
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
partition
required integer ​readOnly
required boolean ​
readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly
required boolean ​awsElasticBlockStore
required object ​
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
awsElasticBlockStore
required object ​volumeID
required string ​
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​partition
required integer ​
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).
partition
required integer ​readOnly
required boolean ​
readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
readOnly
required boolean ​gitRepo
required object ​
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.
gitRepo
required object ​repository
required string ​
repository is the URL
repository
required string ​revision
required string ​
revision is the commit hash for the specified revision.
revision
required string ​directory
required string ​
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.
directory
required string ​secret
required object ​
secret represents a secret that should populate this volume.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
secret
required object ​secretName
required string ​
secretName is the name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
secretName
required string ​items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​defaultMode
required integer ​
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.
defaultMode
required integer ​optional
required boolean ​
optional field specify whether the Secret or its keys must be defined
optional
required boolean ​nfs
required object ​
nfs represents an NFS mount on the host that shares a pod's lifetime
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
nfs
required object ​server
required string ​
server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server
required string ​path
required string ​
path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
path
required string ​readOnly
required boolean ​
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
readOnly
required boolean ​iscsi
required object ​
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
iscsi
required object ​targetPortal
required string ​
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).
targetPortal
required string ​iqn
required string ​
iqn is the target iSCSI Qualified Name.
iqn
required string ​lun
required integer ​
lun represents iSCSI Target Lun number.
lun
required integer ​iscsiInterface
required string ​
iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
iscsiInterface
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​readOnly
required boolean ​
readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
readOnly
required boolean ​portals
required string[] ​
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).
portals
required string[] ​chapAuthDiscovery
required boolean ​
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthDiscovery
required boolean ​chapAuthSession
required boolean ​
chapAuthSession defines whether support iSCSI Session CHAP authentication
chapAuthSession
required boolean ​secretRef
required object ​
secretRef is the CHAP Secret for iSCSI target and initiator authentication
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.initiatorName
required string ​
initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
(target portal):(volume name) will be created for the connection.
initiatorName
required string ​glusterfs
required object ​
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
glusterfs
required object ​endpoints
required string ​
endpoints is the endpoint name that details Glusterfs topology.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
endpoints
required string ​path
required string ​
path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path
required string ​readOnly
required boolean ​
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
readOnly
required boolean ​persistentVolumeClaim
required object ​
persistentVolumeClaimVolumeSource represents a reference to a
PersistentVolumeClaim in the same namespace.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
persistentVolumeClaim
required object ​claimName
required string ​
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
claimName
required string ​readOnly
required boolean ​
readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
readOnly
required boolean ​rbd
required object ​
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
rbd
required object ​monitors
required string[] ​
monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitors
required string[] ​image
required string ​
image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
image
required string ​fsType
required string ​
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
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​pool
required string ​
pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool
required string ​user
required string ​
user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user
required string ​keyring
required string ​
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
keyring
required string ​secretRef
required object ​
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
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean ​
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
readOnly
required boolean ​flexVolume
required object ​
flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
flexVolume
required object ​driver
required string ​
driver is the name of the driver to use for this volume.
driver
required string ​fsType
required string ​
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.
fsType
required string ​secretRef
required object ​
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.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean ​
readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​options
required object ​
options is Optional: this field holds extra command options if any.
options
required object ​cinder
required object ​
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
cinder
required object ​volumeID
required string ​
volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md
volumeID
required string ​fsType
required string ​
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
fsType
required string ​readOnly
required boolean ​
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
readOnly
required boolean ​secretRef
required object ​
secretRef is optional: points to a secret object containing parameters used to connect
to OpenStack.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.cephfs
required object ​
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.
cephfs
required object ​monitors
required string[] ​
monitors is Required: Monitors is a collection of Ceph monitors
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
monitors
required string[] ​path
required string ​
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
path
required string ​user
required string ​
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
user
required string ​secretFile
required string ​
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
secretFile
required string ​secretRef
required object ​
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
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean ​
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
readOnly
required boolean ​flocker
required object ​
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.
flocker
required object ​downwardAPI
required object ​
downwardAPI represents downward API about the pod that should populate this volume
downwardAPI
required object ​items
required object[] ​
Items is a list of downward API volume file
items
required object[] ​path
required string ​
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 '..'
path
required string ​fieldRef
required object ​
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
fieldRef
required object ​resourceFieldRef
required object ​
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
resourceFieldRef
required object ​mode
required integer ​
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.
mode
required integer ​defaultMode
required integer ​
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.
defaultMode
required integer ​fc
required object ​
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
fc
required object ​targetWWNs
required string[] ​
targetWWNs is Optional: FC target worldwide names (WWNs)
targetWWNs
required string[] ​lun
required integer ​
lun is Optional: FC target lun number
lun
required integer ​fsType
required string ​
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.
TODO: how do we prevent errors in the filesystem from compromising the machine
fsType
required string ​readOnly
required boolean ​
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​wwids
required string[] ​
wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
wwids
required string[] ​azureFile
required object ​
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.
azureFile
required object ​secretName
required string ​
secretName is the name of secret that contains Azure Storage Account Name and Key
secretName
required string ​shareName
required string ​
shareName is the azure share Name
shareName
required string ​readOnly
required boolean ​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​configMap
required object ​
configMap represents a configMap that should populate this volume
configMap
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​defaultMode
required integer ​
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.
defaultMode
required integer ​optional
required boolean ​
optional specify whether the ConfigMap or its keys must be defined
optional
required boolean ​vsphereVolume
required object ​
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.
vsphereVolume
required object ​volumePath
required string ​
volumePath is the path that identifies vSphere volume vmdk
volumePath
required string ​fsType
required string ​
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.
fsType
required string ​storagePolicyName
required string ​
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
storagePolicyName
required string ​storagePolicyID
required string ​
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyID
required string ​quobyte
required object ​
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.
quobyte
required object ​registry
required string ​
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
registry
required string ​volume
required string ​
volume is a string that references an already created Quobyte volume by name.
volume
required string ​readOnly
required boolean ​
readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
readOnly
required boolean ​user
required string ​
user to map volume access to
Defaults to serivceaccount user
user
required string ​group
required string ​
group to map volume access to
Default is no group
group
required string ​tenant
required string ​
tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
tenant
required string ​azureDisk
required object ​
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.
azureDisk
required object ​diskName
required string ​
diskName is the Name of the data disk in the blob storage
diskName
required string ​diskURI
required string ​
diskURI is the URI of data disk in the blob storage
diskURI
required string ​cachingMode
required string ​
cachingMode is the Host Caching mode: None, Read Only, Read Write.
cachingMode
required string ​fsType
required string ​
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.
fsType
required string ​readOnly
required boolean ​
readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​kind
required string ​
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
kind
required string ​photonPersistentDisk
required object ​
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.
photonPersistentDisk
required object ​projected
required object ​
projected items for all in one resources secrets, configmaps, and downward API
projected
required object ​sources
required object[] ​
sources is the list of volume projections. Each entry in this list
handles one source.
sources
required object[] ​secret
required object ​
secret information about the secret data to project
secret
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​optional
required boolean ​
optional field specify whether the Secret or its key must be defined
optional
required boolean ​downwardAPI
required object ​
downwardAPI information about the downwardAPI data to project
downwardAPI
required object ​items
required object[] ​
Items is a list of DownwardAPIVolume file
items
required object[] ​path
required string ​
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 '..'
path
required string ​fieldRef
required object ​
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
fieldRef
required object ​resourceFieldRef
required object ​
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
resourceFieldRef
required object ​mode
required integer ​
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.
mode
required integer ​configMap
required object ​
configMap information about the configMap data to project
configMap
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] ​
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 '..'.
items
required object[] ​key
required string ​
key is the key to project.
key
required string ​path
required string ​
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 '..'.
path
required string ​mode
required integer ​
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.
mode
required integer ​optional
required boolean ​
optional specify whether the ConfigMap or its keys must be defined
optional
required boolean ​serviceAccountToken
required object ​
serviceAccountToken is information about the serviceAccountToken data to project
serviceAccountToken
required object ​audience
required string ​
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.
audience
required string ​expirationSeconds
required integer ​
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.
expirationSeconds
required integer ​path
required string ​
path is the path relative to the mount point of the file to project the
token into.
path
required string ​clusterTrustBundle
required object ​
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.
clusterTrustBundle
required object ​.spec.trustBundle
field
of ClusterTrustBundle objects in an auto-updating file.name
required string ​
Select a single ClusterTrustBundle by object name. Mutually-exclusive
with signerName and labelSelector.
name
required string ​signerName
required string ​
Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated.
signerName
required string ​labelSelector
required object ​
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".
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​optional
required boolean ​
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.
optional
required boolean ​path
required string ​
Relative path from the volume root to write the bundle.
path
required string ​defaultMode
required integer ​
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.
defaultMode
required integer ​portworxVolume
required object ​
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.
portworxVolume
required object ​volumeID
required string ​
volumeID uniquely identifies a Portworx volume
volumeID
required string ​fsType
required string ​
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.
fsType
required string ​readOnly
required boolean ​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​scaleIO
required object ​
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.
scaleIO
required object ​gateway
required string ​
gateway is the host address of the ScaleIO API Gateway.
gateway
required string ​system
required string ​
system is the name of the storage system as configured in ScaleIO.
system
required string ​secretRef
required object ​
secretRef references to the secret for ScaleIO user and other
sensitive information. If this is not provided, Login operation will fail.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.sslEnabled
required boolean ​
sslEnabled Flag enable/disable SSL communication with Gateway, default false
sslEnabled
required boolean ​protectionDomain
required string ​
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
protectionDomain
required string ​storagePool
required string ​
storagePool is the ScaleIO Storage Pool associated with the protection domain.
storagePool
required string ​storageMode
required string ​
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
storageMode
required string ​volumeName
required string ​
volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source.
volumeName
required string ​fsType
required string ​
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".
fsType
required string ​readOnly
required boolean ​
readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​storageos
required object ​
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.
storageos
required object ​volumeName
required string ​
volumeName is the human-readable name of the StorageOS volume. Volume
names are only unique within a namespace.
volumeName
required string ​volumeNamespace
required string ​
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.
volumeNamespace
required string ​fsType
required string ​
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.
fsType
required string ​readOnly
required boolean ​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean ​secretRef
required object ​
secretRef specifies the secret to use for obtaining the StorageOS API
credentials. If not specified, default values will be attempted.
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.csi
required object ​
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
csi
required object ​driver
required string ​
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.
driver
required string ​readOnly
required boolean ​
readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
readOnly
required boolean ​fsType
required string ​
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.
fsType
required string ​volumeAttributes
required object ​
volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
volumeAttributes
required object ​nodePublishSecretRef
required object ​
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.
nodePublishSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.ephemeral
required object ​
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.
ephemeral
required object ​volumeClaimTemplate
required object ​
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.
volumeClaimTemplate
required object ​(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).metadata
required object ​
metadata
required object ​name
required string ​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​generateName
required string ​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string ​namespace
required string ​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string ​selfLink
required string ​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string ​uid
required string ​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​resourceVersion
required string ​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string ​generation
required integer ​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer ​creationTimestamp
required object ​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object ​deletionTimestamp
required object ​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object ​deletionGracePeriodSeconds
required integer ​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer ​labels
required object ​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object ​annotations
required object ​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object ​ownerReferences
required object[] ​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] ​apiVersion
required string ​
API version of the referent.
apiVersion
required string ​kind
required string ​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​name
required string ​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​uid
required string ​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​controller
required boolean ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean ​finalizers
required string[] ​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] ​managedFields
required object[] ​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] ​manager
required string ​
Manager is an identifier of the workflow managing these fields.
manager
required string ​operation
required string ​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string ​apiVersion
required string ​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string ​time
required object ​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object ​fieldsType
required string ​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string ​fieldsV1
required object ​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object ​subresource
required string ​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string ​spec
required object ​
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
required object ​accessModes
required string[] ​
accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
accessModes
required string[] ​selector
required object ​
selector is a label query over volumes to consider for binding.
selector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​resources
required object ​
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
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
limits
required object ​requests
required object ​
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/
requests
required object ​volumeName
required string ​
volumeName is the binding reference to the PersistentVolume backing this claim.
volumeName
required string ​storageClassName
required string ​
storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
storageClassName
required string ​volumeMode
required string ​
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
volumeMode
required string ​dataSource
required object ​
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.
dataSource
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​dataSourceRef
required object ​
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.
dataSourceRef
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​namespace
required string ​
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.
namespace
required string ​volumeAttributesClassName
required string ​
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).
volumeAttributesClassName
required string ​image
required object ​
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).
The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
image
required object ​reference
required string ​
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.
reference
required string ​pullPolicy
required string ​
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.
pullPolicy
required string ​initContainers
required object[] ​
List of initialization containers belonging to the pod.
initContainers
required object[] ​name
required string ​
Name of the container specified as a DNS_LABEL.
name
required string ​image
required string ​
Container image name.
image
required string ​command
required string[] ​
Entrypoint array. Not executed within a shell.
command
required string[] ​args
required string[] ​
Arguments to the entrypoint.
args
required string[] ​workingDir
required string ​
Container's working directory.
workingDir
required string ​ports
required object[] ​
List of ports to expose from the container. Not specifying a port here
ports
required object[] ​name
required string ​
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.
name
required string ​hostPort
required integer ​
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.
hostPort
required integer ​containerPort
required integer ​
Number of port to expose on the pod's IP address.
This must be a valid port number, 0 ( x ( 65536.
containerPort
required integer ​protocol
required string ​
Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP".
protocol
required string ​hostIP
required string ​
What host IP to bind the external port to.
hostIP
required string ​envFrom
required object[] ​
envFrom
required object[] ​prefix
required string ​
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
prefix
required string ​configMapRef
required object ​
The ConfigMap to select from
configMapRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the ConfigMap must be defined
optional
required boolean ​secretRef
required object ​
The Secret to select from
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the Secret must be defined
optional
required boolean ​env
required object[] ​
List of environment variables to set in the container.
env
required object[] ​name
required string ​
Name of the environment variable. Must be a C_IDENTIFIER.
name
required string ​value
required string ​
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 "".
value
required string ​valueFrom
required object ​
Source for the environment variable's value. Cannot be used if value is not empty.
valueFrom
required object ​fieldRef
required object ​
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.
fieldRef
required object ​metadata.labels['(KEY)']
, metadata.annotations['(KEY)']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.resourceFieldRef
required object ​
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.
resourceFieldRef
required object ​configMapKeyRef
required object ​
Selects a key of a ConfigMap.
configMapKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key to select.
key
required string ​optional
required boolean ​
Specify whether the ConfigMap or its key must be defined
optional
required boolean ​secretKeyRef
required object ​
Selects a key of a secret in the pod's namespace
secretKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​resources
required object ​
Compute Resources required by this container.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​resizePolicy
required object[] ​
Resources resize policy for the container.
resizePolicy
required object[] ​restartPolicy
required string ​
RestartPolicy defines the restart behavior of individual containers in a pod.
restartPolicy
required string ​volumeMounts
required object[] ​
Pod volumes to mount into the container's filesystem.
volumeMounts
required object[] ​name
required string ​
This must match the Name of a Volume.
name
required string ​readOnly
required boolean ​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean ​recursiveReadOnly
required string ​
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.
recursiveReadOnly
required string ​mountPath
required string ​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string ​subPath
required string ​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string ​mountPropagation
required string ​
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).
mountPropagation
required string ​subPathExpr
required string ​
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.
subPathExpr
required string ​volumeDevices
required object[] ​
volumeDevices is the list of block devices to be used by the container.
volumeDevices
required object[] ​livenessProbe
required object ​
Periodic probe of container liveness.
livenessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​readinessProbe
required object ​
Periodic probe of container service readiness.
readinessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​startupProbe
required object ​
StartupProbe indicates that the Pod has successfully initialized.
startupProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​lifecycle
required object ​
Actions that the management system should take in response to container lifecycle events.
lifecycle
required object ​postStart
required object ​
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
postStart
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​preStop
required object ​
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
preStop
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​terminationMessagePath
required string ​
Optional: Path at which the file to which the container's termination message
terminationMessagePath
required string ​terminationMessagePolicy
required string ​
Indicate how the termination message should be populated. File will use the contents of
terminationMessagePolicy
required string ​imagePullPolicy
required string ​
Image pull policy.
imagePullPolicy
required string ​securityContext
required object ​
SecurityContext defines the security options the container should be run with.
securityContext
required object ​capabilities
required object ​
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.
capabilities
required object ​privileged
required boolean ​
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.
privileged
required boolean ​seLinuxOptions
required object ​
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.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
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.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
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.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
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.
runAsUserName
required string ​hostProcess
required boolean ​
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.
hostProcess
required boolean ​runAsUser
required integer ​
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.
runAsUser
required integer ​runAsGroup
required integer ​
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.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
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.
runAsNonRoot
required boolean ​readOnlyRootFilesystem
required boolean ​
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.
readOnlyRootFilesystem
required boolean ​allowPrivilegeEscalation
required boolean ​
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:
- run as Privileged
- has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
allowPrivilegeEscalation
required boolean ​procMount
required string ​
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.
procMount
required string ​seccompProfile
required object ​
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.
seccompProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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.
localhostProfile
required string ​appArmorProfile
required object ​
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.
appArmorProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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".
localhostProfile
required string ​stdin
required boolean ​
Whether this container should allocate a buffer for stdin in the container runtime.
stdin
required boolean ​stdinOnce
required boolean ​
StdinOnce default is false
stdinOnce
required boolean ​tty
required boolean ​
TTY default is false.
tty
required boolean ​containers
required object[] ​
List of containers belonging to the pod.
containers
required object[] ​name
required string ​
Name of the container specified as a DNS_LABEL.
name
required string ​image
required string ​
Container image name.
image
required string ​command
required string[] ​
Entrypoint array. Not executed within a shell.
command
required string[] ​args
required string[] ​
Arguments to the entrypoint.
args
required string[] ​workingDir
required string ​
Container's working directory.
workingDir
required string ​ports
required object[] ​
List of ports to expose from the container. Not specifying a port here
ports
required object[] ​name
required string ​
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.
name
required string ​hostPort
required integer ​
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.
hostPort
required integer ​containerPort
required integer ​
Number of port to expose on the pod's IP address.
This must be a valid port number, 0 ( x ( 65536.
containerPort
required integer ​protocol
required string ​
Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP".
protocol
required string ​hostIP
required string ​
What host IP to bind the external port to.
hostIP
required string ​envFrom
required object[] ​
envFrom
required object[] ​prefix
required string ​
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
prefix
required string ​configMapRef
required object ​
The ConfigMap to select from
configMapRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the ConfigMap must be defined
optional
required boolean ​secretRef
required object ​
The Secret to select from
secretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean ​
Specify whether the Secret must be defined
optional
required boolean ​env
required object[] ​
List of environment variables to set in the container.
env
required object[] ​name
required string ​
Name of the environment variable. Must be a C_IDENTIFIER.
name
required string ​value
required string ​
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 "".
value
required string ​valueFrom
required object ​
Source for the environment variable's value. Cannot be used if value is not empty.
valueFrom
required object ​fieldRef
required object ​
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.
fieldRef
required object ​metadata.labels['(KEY)']
, metadata.annotations['(KEY)']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.resourceFieldRef
required object ​
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.
resourceFieldRef
required object ​configMapKeyRef
required object ​
Selects a key of a ConfigMap.
configMapKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key to select.
key
required string ​optional
required boolean ​
Specify whether the ConfigMap or its key must be defined
optional
required boolean ​secretKeyRef
required object ​
Selects a key of a secret in the pod's namespace
secretKeyRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​resources
required object ​
Compute Resources required by this container.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​resizePolicy
required object[] ​
Resources resize policy for the container.
resizePolicy
required object[] ​restartPolicy
required string ​
RestartPolicy defines the restart behavior of individual containers in a pod.
restartPolicy
required string ​volumeMounts
required object[] ​
Pod volumes to mount into the container's filesystem.
volumeMounts
required object[] ​name
required string ​
This must match the Name of a Volume.
name
required string ​readOnly
required boolean ​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean ​recursiveReadOnly
required string ​
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.
recursiveReadOnly
required string ​mountPath
required string ​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string ​subPath
required string ​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string ​mountPropagation
required string ​
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).
mountPropagation
required string ​subPathExpr
required string ​
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.
subPathExpr
required string ​volumeDevices
required object[] ​
volumeDevices is the list of block devices to be used by the container.
volumeDevices
required object[] ​livenessProbe
required object ​
Periodic probe of container liveness.
livenessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​readinessProbe
required object ​
Periodic probe of container service readiness.
readinessProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​startupProbe
required object ​
StartupProbe indicates that the Pod has successfully initialized.
startupProbe
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
TCPSocket specifies a connection to a TCP port.
tcpSocket
required object ​grpc
required object ​
GRPC specifies a GRPC HealthCheckRequest.
grpc
required object ​port
required integer ​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer ​service
required string ​
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.
service
required string ​initialDelaySeconds
required integer ​
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
initialDelaySeconds
required integer ​timeoutSeconds
required integer ​
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
timeoutSeconds
required integer ​periodSeconds
required integer ​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer ​successThreshold
required integer ​
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.
successThreshold
required integer ​failureThreshold
required integer ​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer ​terminationGracePeriodSeconds
required integer ​
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.
terminationGracePeriodSeconds
required integer ​lifecycle
required object ​
Actions that the management system should take in response to container lifecycle events.
lifecycle
required object ​postStart
required object ​
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
postStart
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​preStop
required object ​
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
preStop
required object ​exec
required object ​
Exec specifies a command to execute in the container.
exec
required object ​command
required string[] ​
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.
command
required string[] ​httpGet
required object ​
HTTPGet specifies an HTTP GET request to perform.
httpGet
required object ​path
required string ​
Path to access on the HTTP server.
path
required string ​port
required object ​
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.
port
required object ​host
required string ​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string ​scheme
required string ​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string ​tcpSocket
required object ​
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.
tcpSocket
required object ​terminationMessagePath
required string ​
Optional: Path at which the file to which the container's termination message
terminationMessagePath
required string ​terminationMessagePolicy
required string ​
Indicate how the termination message should be populated. File will use the contents of
terminationMessagePolicy
required string ​imagePullPolicy
required string ​
Image pull policy.
imagePullPolicy
required string ​securityContext
required object ​
SecurityContext defines the security options the container should be run with.
securityContext
required object ​capabilities
required object ​
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.
capabilities
required object ​privileged
required boolean ​
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.
privileged
required boolean ​seLinuxOptions
required object ​
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.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
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.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
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.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
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.
runAsUserName
required string ​hostProcess
required boolean ​
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.
hostProcess
required boolean ​runAsUser
required integer ​
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.
runAsUser
required integer ​runAsGroup
required integer ​
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.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
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.
runAsNonRoot
required boolean ​readOnlyRootFilesystem
required boolean ​
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.
readOnlyRootFilesystem
required boolean ​allowPrivilegeEscalation
required boolean ​
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:
- run as Privileged
- has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
allowPrivilegeEscalation
required boolean ​procMount
required string ​
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.
procMount
required string ​seccompProfile
required object ​
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.
seccompProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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.
localhostProfile
required string ​appArmorProfile
required object ​
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.
appArmorProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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".
localhostProfile
required string ​stdin
required boolean ​
Whether this container should allocate a buffer for stdin in the container runtime.
stdin
required boolean ​stdinOnce
required boolean ​
StdinOnce default is false
stdinOnce
required boolean ​tty
required boolean ​
TTY default is false.
tty
required boolean ​restartPolicy
required string ​
Restart policy for all containers within the pod.
restartPolicy
required string ​terminationGracePeriodSeconds
required integer ​
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
terminationGracePeriodSeconds
required integer ​activeDeadlineSeconds
required integer ​
Optional duration in seconds the pod may be active on the node relative to
activeDeadlineSeconds
required integer ​dnsPolicy
required string ​
Set DNS policy for the pod.
dnsPolicy
required string ​nodeSelector
required object ​
NodeSelector is a selector which must be true for the pod to fit on a node.
nodeSelector
required object ​serviceAccountName
required string ​
ServiceAccountName is the name of the ServiceAccount to use to run this pod.
serviceAccountName
required string ​automountServiceAccountToken
required boolean ​
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
automountServiceAccountToken
required boolean ​nodeName
required string ​
NodeName indicates in which node this pod is scheduled.
nodeName
required string ​hostNetwork
required boolean ​
Host networking requested for this pod. Use the host's network namespace.
hostNetwork
required boolean ​hostPID
required boolean ​
Use the host's pid namespace.
hostPID
required boolean ​hostIPC
required boolean ​
Use the host's ipc namespace.
hostIPC
required boolean ​shareProcessNamespace
required boolean ​
Share a single process namespace between all of the containers in a pod.
shareProcessNamespace
required boolean ​securityContext
required object ​
SecurityContext holds pod-level security attributes and common container settings.
securityContext
required object ​seLinuxOptions
required object ​
The SELinux context to be applied to all containers.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in SecurityContext. If set in
both SecurityContext and PodSecurityContext, the value specified in SecurityContext
takes precedence for that container.
Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
The Windows specific settings applied to all containers.
If unspecified, the options within a container's SecurityContext 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.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
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.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
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.
runAsUserName
required string ​hostProcess
required boolean ​
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.
hostProcess
required boolean ​runAsUser
required integer ​
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsUser
required integer ​runAsGroup
required integer ​
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
required boolean ​supplementalGroups
required integer[] ​
A list of groups applied to the first process run in each container, in
addition to the container's primary GID and fsGroup (if specified). If
the SupplementalGroupsPolicy feature is enabled, the
supplementalGroupsPolicy field determines whether these are in addition
to or instead of any group memberships defined in the container image.
If unspecified, no additional groups are added, though group memberships
defined in the container image may still be used, depending on the
supplementalGroupsPolicy field.
Note that this field cannot be set when spec.os.name is windows.
supplementalGroups
required integer[] ​supplementalGroupsPolicy
required string ​
Defines how supplemental groups of the first container processes are calculated.
Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
and the container runtime must implement support for this feature.
Note that this field cannot be set when spec.os.name is windows.
TODO: update the default value to "Merge" when spec.os.name is not windows in v1.34
supplementalGroupsPolicy
required string ​fsGroup
required integer ​
A special supplemental group that applies to all containers in a pod.
Some volume types allow the Kubelet to change the ownership of that volume
to be owned by the pod:
- The owning GID will be the FSGroup
- The setgid bit is set (new files created in the volume will be owned by FSGroup)
- The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume.
Note that this field cannot be set when spec.os.name is windows.
fsGroup
required integer ​sysctls
required object[] ​
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Note that this field cannot be set when spec.os.name is windows.
sysctls
required object[] ​fsGroupChangePolicy
required string ​
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
before being exposed inside Pod. This field will only apply to
volume types which support fsGroup based ownership(and permissions).
It will have no effect on ephemeral volume types such as: secret, configmaps
and emptydir.
Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
Note that this field cannot be set when spec.os.name is windows.
fsGroupChangePolicy
required string ​seccompProfile
required object ​
The seccomp options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
seccompProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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.
localhostProfile
required string ​appArmorProfile
required object ​
appArmorProfile is the AppArmor options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
appArmorProfile
required object ​type
required string ​
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.
type
required string ​localhostProfile
required string ​
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".
localhostProfile
required string ​seLinuxChangePolicy
required string ​
seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime.
This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with -o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
Note that this field cannot be set when spec.os.name is windows.
seLinuxChangePolicy
required string ​-o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.imagePullSecrets
required object[] ​
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
imagePullSecrets
required object[] ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.hostname
required string ​
Specifies the hostname of the Pod
hostname
required string ​subdomain
required string ​
If specified, the fully qualified Pod hostname will be "(hostname).(subdomain).(pod namespace).svc.(cluster domain)".
subdomain
required string ​affinity
required object ​
If specified, the pod's scheduling constraints
affinity
required object ​nodeAffinity
required object ​
Describes node affinity scheduling rules for the pod.
nodeAffinity
required object ​requiredDuringSchedulingIgnoredDuringExecution
required object ​
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.
requiredDuringSchedulingIgnoredDuringExecution
required object ​nodeSelectorTerms
required object[] ​
Required. A list of node selector terms. The terms are ORed.
nodeSelectorTerms
required object[] ​matchExpressions
required object[] ​
A list of node selector requirements by node's labels.
matchExpressions
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchFields
required object[] ​
A list of node selector requirements by node's fields.
matchFields
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​preferredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
preferredDuringSchedulingIgnoredDuringExecution
required object[] ​weight
required integer ​
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
weight
required integer ​preference
required object ​
A node selector term, associated with the corresponding weight.
preference
required object ​matchExpressions
required object[] ​
A list of node selector requirements by node's labels.
matchExpressions
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchFields
required object[] ​
A list of node selector requirements by node's fields.
matchFields
required object[] ​key
required string ​
The label key that the selector applies to.
key
required string ​operator
required string ​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string ​values
required string[] ​
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.
values
required string[] ​podAffinity
required object ​
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAffinity
required object ​requiredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
requiredDuringSchedulingIgnoredDuringExecution
required object[] ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).preferredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
preferredDuringSchedulingIgnoredDuringExecution
required object[] ​weight
required integer ​
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
weight
required integer ​podAffinityTerm
required object ​
Required. A pod affinity term, associated with the corresponding weight.
podAffinityTerm
required object ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).podAntiAffinity
required object ​
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity
required object ​requiredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
requiredDuringSchedulingIgnoredDuringExecution
required object[] ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).preferredDuringSchedulingIgnoredDuringExecution
required object[] ​
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.
preferredDuringSchedulingIgnoredDuringExecution
required object[] ​weight
required integer ​
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
weight
required integer ​podAffinityTerm
required object ​
Required. A pod affinity term, associated with the corresponding weight.
podAffinityTerm
required object ​labelSelector
required object ​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​namespaces
required string[] ​
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".
namespaces
required string[] ​topologyKey
required string ​
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.
topologyKey
required string ​namespaceSelector
required object ​
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.
namespaceSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​matchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
matchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).mismatchLabelKeys
required string[] ​
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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
mismatchLabelKeys
required string[] ​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.
This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).schedulerName
required string ​
If specified, the pod will be dispatched by specified scheduler.
If not specified, the pod will be dispatched by default scheduler.
schedulerName
required string ​tolerations
required object[] ​
If specified, the pod's tolerations.
tolerations
required object[] ​key
required string ​
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.
key
required string ​operator
required string ​
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.
operator
required string ​value
required string ​
Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
value
required string ​effect
required string ​
Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
effect
required string ​tolerationSeconds
required integer ​
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.
tolerationSeconds
required integer ​hostAliases
required object[] ​
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts
hostAliases
required object[] ​priorityClassName
required string ​
If specified, indicates the pod's priority.
priorityClassName
required string ​priority
required integer ​
priority
required integer ​dnsConfig
required object ​
Specifies the DNS parameters of a pod.
dnsConfig
required object ​nameservers
required string[] ​
A list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.
Duplicated nameservers will be removed.
nameservers
required string[] ​searches
required string[] ​
A list of DNS search domains for host-name lookup.
This will be appended to the base search paths generated from DNSPolicy.
Duplicated search paths will be removed.
searches
required string[] ​options
required object[] ​
A list of DNS resolver options.
This will be merged with the base options generated from DNSPolicy.
Duplicated entries will be removed. Resolution options given in Options
will override those that appear in the base DNSPolicy.
options
required object[] ​readinessGates
required object[] ​
If specified, all readiness gates will be evaluated for pod readiness.
readinessGates
required object[] ​conditionType
required string ​
ConditionType refers to a condition in the pod's condition list with matching type.
conditionType
required string ​runtimeClassName
required string ​
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod
runtimeClassName
required string ​enableServiceLinks
required boolean ​
EnableServiceLinks indicates whether information about services should be injected into pod's
environment variables, matching the syntax of Docker links.
enableServiceLinks
required boolean ​preemptionPolicy
required string ​
PreemptionPolicy is the Policy for preempting pods with lower priority.
preemptionPolicy
required string ​overhead
required object ​
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
overhead
required object ​topologySpreadConstraints
required object[] ​
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.
topologySpreadConstraints
required object[] ​maxSkew
required integer ​
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.
maxSkew
required integer ​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 |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.topologyKey
required string ​
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.
topologyKey
required string ​whenUnsatisfiable
required string ​
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.
whenUnsatisfiable
required string ​labelSelector
required object ​
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.
labelSelector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​minDomains
required integer ​
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.
minDomains
required integer ​nodeAffinityPolicy
required string ​
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.
This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
nodeAffinityPolicy
required string ​nodeTaintsPolicy
required string ​
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.
This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
nodeTaintsPolicy
required string ​matchLabelKeys
required string[] ​
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).
matchLabelKeys
required string[] ​setHostnameAsFQDN
required boolean ​
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).
In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).
In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN.
setHostnameAsFQDN
required boolean ​os
required object ​
Specifies the OS of the containers in the pod.
os
required object ​name
required string ​
Name is the name of the operating system. The currently supported values are linux and windows.
Additional value may be defined in future and can be one of:
https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration
Clients should expect to handle additional values and treat unrecognized values in this field as os: null
name
required string ​hostUsers
required boolean ​
Use the host's user namespace.
hostUsers
required boolean ​schedulingGates
required object[] ​
SchedulingGates is an opaque list of values that if specified will block scheduling the pod.
If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the
scheduler will not attempt to schedule the pod.
schedulingGates
required object[] ​name
required string ​
Name of the scheduling gate.
Each scheduling gate must have a unique name field.
name
required string ​resourceClaims
required object[] ​
ResourceClaims defines which ResourceClaims must be allocated
and reserved before the Pod is allowed to start. The resources
will be made available to those containers which consume them
by name.
resourceClaims
required object[] ​name
required string ​
Name uniquely identifies this resource claim inside the pod.
This must be a DNS_LABEL.
name
required string ​resourceClaimName
required string ​
ResourceClaimName is the name of a ResourceClaim object in the same
namespace as this pod.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must
be set.
resourceClaimName
required string ​resourceClaimTemplateName
required string ​
ResourceClaimTemplateName is the name of a ResourceClaimTemplate
object in the same namespace as this pod.
The template will be used to create a new ResourceClaim, which will
be bound to this pod. When this pod is deleted, the ResourceClaim
will also be deleted. The pod name and resource name, along with a
generated component, will be used to form a unique name for the
ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.
This field is immutable and no changes will be made to the
corresponding ResourceClaim by the control plane after creating the
ResourceClaim.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must
be set.
resourceClaimTemplateName
required string ​resources
required object ​
Resources is the total amount of CPU and Memory resources required by all
containers in the pod. It supports specifying Requests and Limits for
"cpu" and "memory" resource names only. ResourceClaims are not supported.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​volumeClaim
required object ​
VolumeClaim holds the definition for the main workspace persistent volume.
This volume is guaranteed to exist for the lifespan of the workspace.
Defaults will be applied for fields that aren't specified.
volumeClaim
required object ​metadata
required object ​
metadata
required object ​spec
required object ​
spec
required object ​accessModes
required string[] ​
accessModes contains the desired access modes the volume should have.
accessModes
required string[] ​selector
required object ​
selector is a label query over volumes to consider for binding.
selector
required object ​matchLabels
required object ​
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.
matchLabels
required object ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​values
required string[] ​
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.
values
required string[] ​resources
required object ​
resources represents the minimum resources the volume should have.
resources
required object ​limits
required object ​
Limits describes the maximum amount of compute resources allowed.
limits
required object ​requests
required object ​
Requests describes the minimum amount of compute resources required.
requests
required object ​claims
required object[] ​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
claims
required object[] ​name
required string ​
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.
name
required string ​request
required string ​
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.
request
required string ​volumeName
required string ​
volumeName is the binding reference to the PersistentVolume backing this claim.
volumeName
required string ​storageClassName
required string ​
storageClassName is the name of the StorageClass required by the claim.
storageClassName
required string ​volumeMode
required string ​
volumeMode defines what type of volume is required by the claim.
volumeMode
required string ​dataSource
required object ​
dataSource field can be used to specify either:
dataSource
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​dataSourceRef
required object ​
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
dataSourceRef
required object ​apiGroup
required string ​
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.
apiGroup
required string ​kind
required string ​
Kind is the type of resource being referenced
kind
required string ​name
required string ​
Name is the name of resource being referenced
name
required string ​namespace
required string ​
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.
namespace
required string ​volumeAttributesClassName
required string ​
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
volumeAttributesClassName
required string ​podTimeout
required string ​
PodTimeout specifies a maximum duration to wait for the workspace pod to start up before failing.
Default: 10m
podTimeout
required string ​nodeArchitecture
required string ​
NodeArchitecture specifies the node architecture the workspace image will be built for.
Only necessary if you need to build workspace images on the fly in the kubernetes cluster and your cluster is mixed architecture.
nodeArchitecture
required string ​spaceTemplateRef
required object ​
SpaceTemplateRef is a reference to the space that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
spaceTemplateRef
required object ​name
required string ​
Name holds the name of the template to reference.
name
required string ​version
required string ​
Version holds the template version to use. Version is expected to
be in semantic versioning format. Alternatively, you can also exchange
major, minor or patch with an 'x' to tell Loft to automatically select
the latest major, minor or patch version.
version
required string ​syncOnce
required boolean ​
SyncOnce tells the controller to sync the instance once with the template.
This is useful if you want to sync an instance after a template was changed.
To automatically sync an instance with a template, use 'x.x.x' as version
instead.
syncOnce
required boolean ​spaceTemplate
required object ​
SpaceTemplate is the inline template for a space that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
spaceTemplate
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the space instance template
instanceTemplate
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​access
required object ​
The space access
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​virtualClusterTemplateRef
required object ​
VirtualClusterTemplateRef is a reference to the virtual cluster that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
virtualClusterTemplateRef
required object ​name
required string ​
Name holds the name of the template to reference.
name
required string ​version
required string ​
Version holds the template version to use. Version is expected to
be in semantic versioning format. Alternatively, you can also exchange
major, minor or patch with an 'x' to tell Loft to automatically select
the latest major, minor or patch version.
version
required string ​syncOnce
required boolean ​
SyncOnce tells the controller to sync the instance once with the template.
This is useful if you want to sync an instance after a template was changed.
To automatically sync an instance with a template, use 'x.x.x' as version
instead.
syncOnce
required boolean ​virtualClusterTemplate
required object ​
VirtualClusterTemplate is the inline template for a virtual cluster that should get created for this DevPod.
If this is specified, the kubernetes provider will be selected automatically.
virtualClusterTemplate
required object ​metadata
required object ​
metadata
required object ​instanceTemplate
required object ​
InstanceTemplate holds the virtual cluster instance template
instanceTemplate
required object ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string ​access
required object ​
Access defines the access of users and teams to the virtual cluster.
access
required object ​defaultClusterRole
required string ​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string ​rules
required object[] ​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] ​pro
required object ​
Pro defines the pro settings for the virtual cluster
pro
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster is a pro cluster or not
enabled
required boolean ​helmRelease
required object ​
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease
required object ​chart
required object ​
infos about what chart to deploy
chart
required object ​name
required string ​
the name of the helm chart
name
required string ​repo
required string ​
the repo of the helm chart
repo
required string ​username
required string ​
The username that is required for this repository
username
required string ​password
required string ​
The password that is required for this repository
password
required string ​version
required string ​
the version of the helm chart to use
version
required string ​values
required string ​
the values for the given chart
values
required string ​accessPoint
required object ​
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint
required object ​ingress
required object ​
Ingress defines virtual cluster access via ingress
ingress
required object ​enabled
required boolean ​
Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires
the connected cluster to have the loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.
enabled
required boolean ​loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.forwardToken
required boolean ​
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken
required boolean ​spaceTemplate
required object ​
SpaceTemplate holds the space template
spaceTemplate
required object ​metadata
required object ​
metadata
required object ​objects
required string ​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects
required string ​charts
required object[] ​
Charts are helm charts that should get deployed
charts
required object[] ​name
required string ​
Name is the chart name in the repository
name
required string ​version
required string ​
Version is the chart version in the repository
version
required string ​repoURL
required string ​
RepoURL is the repo url where the chart can be found
repoURL
required string ​username
required string ​
The username that is required for this repository
username
required string ​usernameRef
required object ​
The username that is required for this repository
usernameRef
required object ​password
required string ​
The password that is required for this repository
password
required string ​passwordRef
required object ​
The password that is required for this repository
passwordRef
required object ​insecureSkipTlsVerify
required boolean ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​releaseName
required string ​
ReleaseName is the preferred release name of the app
releaseName
required string ​releaseNamespace
required string ​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string ​values
required string ​
Values are the values that should get passed to the chart
values
required string ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string ​apps
required object[] ​
Apps specifies the apps that should get deployed by this template
apps
required object[] ​name
required string ​
Name of the target app
name
required string ​namespace
required string ​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string ​releaseName
required string ​
ReleaseName is the name of the app release
releaseName
required string ​version
required string ​
Version of the app
version
required string ​parameters
required string ​
Parameters to use for the app
parameters
required string ​workspaceEnv
required {key: object} ​
WorkspaceEnv are environment variables that should be available within the created workspace.
workspaceEnv
required {key: object} ​value
required string ​
Value of this option.
value
required string ​valueFrom
required object ​
ValueFrom specifies a secret where this value should be taken from.
valueFrom
required object ​projectSecretRef
required object ​
ProjectSecretRef is the project secret to use for this value.
projectSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​sharedSecretRef
required object ​
SharedSecretRef is the shared secret to use for this value.
sharedSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​instanceTemplate
required object ​
InstanceTemplate holds the workspace instance template
instanceTemplate
required object ​credentialForwarding
required object ​
CredentialForwarding specifies controls for how workspaces created by this template forward credentials into the workspace
credentialForwarding
required object ​provider
required object ​
Provider holds the legacy VM provider configuration
provider
required object ​name
required string ​
Name is the name of the provider. This can also be an url.
name
required string ​options
required {key: object} ​
Options are the provider option values
options
required {key: object} ​value
required string ​
Value of this option.
value
required string ​valueFrom
required object ​
ValueFrom specifies a secret where this value should be taken from.
valueFrom
required object ​projectSecretRef
required object ​
ProjectSecretRef is the project secret to use for this value.
projectSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​sharedSecretRef
required object ​
SharedSecretRef is the shared secret to use for this value.
sharedSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​env
required {key: object} ​
Env are environment options to set when using the provider.
env
required {key: object} ​value
required string ​
Value of this option.
value
required string ​valueFrom
required object ​
ValueFrom specifies a secret where this value should be taken from.
valueFrom
required object ​projectSecretRef
required object ​
ProjectSecretRef is the project secret to use for this value.
projectSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​sharedSecretRef
required object ​
SharedSecretRef is the shared secret to use for this value.
sharedSecretRef
required object ​name
required string ​
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
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string ​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string ​
The key of the secret to select from. Must be a valid secret key.
key
required string ​optional
required boolean ​
Specify whether the Secret or its key must be defined
optional
required boolean ​parameters
required object[] ​
Parameters define additional app parameters that will set provider values
parameters
required object[] ​variable
required string ​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string ​label
required string ​
Label is the label to show for this parameter
label
required string ​description
required string ​
Description is the description to show for this parameter
description
required string ​type
required string ​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] ​min
required integer ​
Min is the minimum number if type is number
min
required integer ​max
required integer ​
Max is the maximum number if type is number
max
required integer ​required
required boolean ​
Required specifies if this parameter is required
required
required boolean ​defaultValue
required string ​
DefaultValue is the default value if none is specified
defaultValue
required string ​placeholder
required string ​
Placeholder shown in the UI
placeholder
required string ​invalidation
required string ​
Invalidation regex that if matched will reject the input
invalidation
required string ​validation
required string ​
Validation regex that if matched will allow the input
validation
required string ​section
required string ​
Section where this app should be displayed. Apps with the same section name will be grouped together
section
required string ​version
required string ​
Version is the version. Needs to be in X.X.X format.
version
required string ​access
required object[] ​
Access holds the access rights for users and teams
access
required object[] ​name
required string ​
Name is an optional name that is used for this access rule
name
required string ​verbs
required string[] ​
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
verbs
required string[] ​subresources
required string[] ​
Subresources defines the sub resources that are allowed by this access rule
subresources
required string[] ​users
required string[] ​
Users specifies which users should be able to access this secret with the aforementioned verbs
users
required string[] ​teams
required string[] ​
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams
required string[] ​status
required object ​
status
required object ​devPodEnvironmentTemplates
required object[] ​
DevPodEnvironmentTemplates holds all the allowed environment templates
devPodEnvironmentTemplates
required object[] ​kind
required string ​
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​apiVersion
required string ​
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion
required string ​metadata
required object ​
metadata
required object ​name
required string ​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​generateName
required string ​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string ​namespace
required string ​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string ​selfLink
required string ​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string ​uid
required string ​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​resourceVersion
required string ​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string ​generation
required integer ​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer ​creationTimestamp
required object ​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object ​deletionTimestamp
required object ​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object ​deletionGracePeriodSeconds
required integer ​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer ​labels
required object ​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object ​annotations
required object ​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object ​ownerReferences
required object[] ​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] ​apiVersion
required string ​
API version of the referent.
apiVersion
required string ​kind
required string ​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​name
required string ​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​uid
required string ​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​controller
required boolean ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean ​finalizers
required string[] ​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] ​managedFields
required object[] ​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] ​manager
required string ​
Manager is an identifier of the workflow managing these fields.
manager
required string ​operation
required string ​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string ​apiVersion
required string ​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string ​time
required object ​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object ​fieldsType
required string ​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string ​fieldsV1
required object ​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object ​subresource
required string ​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string ​spec
required object ​
spec
required object ​displayName
required string ​
DisplayName is the name that should be displayed in the UI
displayName
required string ​description
required string ​
Description describes the environment template
description
required string ​owner
required object ​
Owner holds the owner of this object
owner
required object ​access
required object[] ​
Access to the DevPod machine instance object itself
access
required object[] ​name
required string ​
Name is an optional name that is used for this access rule
name
required string ​verbs
required string[] ​
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
verbs
required string[] ​subresources
required string[] ​
Subresources defines the sub resources that are allowed by this access rule
subresources
required string[] ​users
required string[] ​
Users specifies which users should be able to access this secret with the aforementioned verbs
users
required string[] ​teams
required string[] ​
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams
required string[] ​template
required object ​
Template is the inline template to use for DevPod environments
template
required object ​git
required object ​
Git holds configuration for git environment spec source
git
required object ​repository
required string ​
Repository stores repository URL for Git environment spec source
repository
required string ​revision
required string ​
Revision stores revision to checkout in repository
revision
required string ​subpath
required string ​
SubPath stores subpath within Repositor where environment spec is
subpath
required string ​useProjectGitCredentials
required boolean ​
UseProjectGitCredentials specifies if the project git credentials should be used instead of local ones for this environment
useProjectGitCredentials
required boolean ​inline
required string ​
Inline holds an inline devcontainer.json definition
inline
required string ​workspaceRepositoryCloneStrategy
required string ​
WorkspaceRepositoryCloneStrategy determines how the workspaces git repository will be checked out in the pod if the workspace is git based
workspaceRepositoryCloneStrategy
required string ​workspaceRepositorySkipLFS
required boolean ​
WorkspaceRepositorySkipLFS specifies if git lfs will be skipped when cloning the repository into the workspace
workspaceRepositorySkipLFS
required boolean ​versions
required object[] ​
Versions are different versions of the template that can be referenced as well
versions
required object[] ​template
required object ​
Template holds the environment template definition
template
required object ​git
required object ​
Git holds configuration for git environment spec source
git
required object ​repository
required string ​
Repository stores repository URL for Git environment spec source
repository
required string ​revision
required string ​
Revision stores revision to checkout in repository
revision
required string ​subpath
required string ​
SubPath stores subpath within Repositor where environment spec is
subpath
required string ​useProjectGitCredentials
required boolean ​
UseProjectGitCredentials specifies if the project git credentials should be used instead of local ones for this environment
useProjectGitCredentials
required boolean ​inline
required string ​
Inline holds an inline devcontainer.json definition
inline
required string ​workspaceRepositoryCloneStrategy
required string ​
WorkspaceRepositoryCloneStrategy determines how the workspaces git repository will be checked out in the pod if the workspace is git based
workspaceRepositoryCloneStrategy
required string ​workspaceRepositorySkipLFS
required boolean ​
WorkspaceRepositorySkipLFS specifies if git lfs will be skipped when cloning the repository into the workspace
workspaceRepositorySkipLFS
required boolean ​version
required string ​
Version is the version. Needs to be in X.X.X format.
version
required string ​status
required object ​
status
required object ​devPodWorkspacePresets
required object[] ​
DevPodWorkspacePresets holds all the allowed workspace presets
devPodWorkspacePresets
required object[] ​kind
required string ​
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​apiVersion
required string ​
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion
required string ​metadata
required object ​
metadata
required object ​name
required string ​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​generateName
required string ​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string ​namespace
required string ​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string ​selfLink
required string ​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string ​uid
required string ​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​resourceVersion
required string ​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string ​generation
required integer ​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer ​creationTimestamp
required object ​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object ​deletionTimestamp
required object ​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object ​deletionGracePeriodSeconds
required integer ​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer ​labels
required object ​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object ​annotations
required object ​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object ​ownerReferences
required object[] ​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] ​apiVersion
required string ​
API version of the referent.
apiVersion
required string ​kind
required string ​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string ​name
required string ​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string ​uid
required string ​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string ​controller
required boolean ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean ​finalizers
required string[] ​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] ​managedFields
required object[] ​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] ​manager
required string ​
Manager is an identifier of the workflow managing these fields.
manager
required string ​operation
required string ​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string ​apiVersion
required string ​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string ​time
required object ​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object ​fieldsType
required string ​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string ​fieldsV1
required object ​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object ​subresource
required string ​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string ​spec
required object ​
spec
required object ​displayName
required string ​
DisplayName is the name that should be displayed in the UI
displayName
required string ​source
required object ​
Source stores inline path of project source
source
required object ​infrastructureRef
required object ​
InfrastructureRef stores reference to DevPodWorkspaceTemplate to use
infrastructureRef
required object ​name
required string ​
Name holds the name of the template to reference.
name
required string ​version
required string ​
Version holds the template version to use. Version is expected to
be in semantic versioning format. Alternatively, you can also exchange
major, minor or patch with an 'x' to tell Loft to automatically select
the latest major, minor or patch version.
version
required string ​syncOnce
required boolean ​
SyncOnce tells the controller to sync the instance once with the template.
This is useful if you want to sync an instance after a template was changed.
To automatically sync an instance with a template, use 'x.x.x' as version
instead.
syncOnce
required boolean ​environmentRef
required object ​
EnvironmentRef stores reference to DevPodEnvironmentTemplate
environmentRef
required object ​useProjectGitCredentials
required boolean ​
UseProjectGitCredentials specifies if the project git credentials should be used instead of local ones for this environment
useProjectGitCredentials
required boolean ​owner
required object ​
Owner holds the owner of this object
owner
required object ​access
required object[] ​
Access to the DevPod machine instance object itself
access
required object[] ​name
required string ​
Name is an optional name that is used for this access rule
name
required string ​verbs
required string[] ​
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
verbs
required string[] ​subresources
required string[] ​
Subresources defines the sub resources that are allowed by this access rule
subresources
required string[] ​users
required string[] ​
Users specifies which users should be able to access this secret with the aforementioned verbs
users
required string[] ​teams
required string[] ​
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams
required string[] ​versions
required object[] ​
Versions are different versions of the template that can be referenced as well
versions
required object[] ​version
required string ​
Version is the version. Needs to be in X.X.X format.
version
required string ​source
required object ​
Source stores inline path of project source
source
required object ​infrastructureRef
required object ​
InfrastructureRef stores reference to DevPodWorkspaceTemplate to use
infrastructureRef
required object ​name
required string ​
Name holds the name of the template to reference.
name
required string ​version
required string ​
Version holds the template version to use. Version is expected to
be in semantic versioning format. Alternatively, you can also exchange
major, minor or patch with an 'x' to tell Loft to automatically select
the latest major, minor or patch version.
version
required string ​syncOnce
required boolean ​
SyncOnce tells the controller to sync the instance once with the template.
This is useful if you want to sync an instance after a template was changed.
To automatically sync an instance with a template, use 'x.x.x' as version
instead.
syncOnce
required boolean ​status
required object ​
status
required object ​defaultDevPodEnvironmentTemplate
required string ​
DefaultDevPodEnvironmentTemplate
defaultDevPodEnvironmentTemplate
required string ​Project Templates (Get)​
You can retrieve all allowed templates through this API.
- kubectl
- curl
Run the following command:
# Exchange my-object in the url below with the name of the Project Templates
kubectl get --raw "/kubernetes/management/apis/management.loft.sh/v1/projects/my-object/templates"
Run the following curl command:
# Exchange my-object in the url below with the name of the Project Templates
curl -s -X GET --insecure \
"https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects/my-object/templates" \
-H "Authorization: Bearer $ACCESS_KEY"