RayService is the Schema for the rayservices API
Last changed in Kuberay v0.5.0
APIVersion defines the versioned schema of this representation of an object.
Kind is a string value representing the REST resource this object represents.
RayServiceSpec defines the desired state of RayService
EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! NOTE: json tags are required.
AutoscalerOptions specifies optional configuration for the Ray autoscaler.
Optional list of environment variables to set in the autoscaler container.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in t
Source for the environment variable's value. Cannot be used if value is not empty.
Selects a key of a ConfigMap.
The key to select.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its key must be defined
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
Selects a key of a secret in the pod's namespace
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
Optional list of sources to populate environment variables in the autoscaler container.
The ConfigMap to select from
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap must be defined
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
The Secret to select from
Name of the referent. More info: https://kubernetes.
Specify whether the Secret must be defined
IdleTimeoutSeconds is the number of seconds to wait before scaling down a worker pod which is not us
Image optionally overrides the autoscaler's container image.
ImagePullPolicy optionally overrides the autoscaler container's image pull policy.
Resources specifies optional resource request and limit overrides for the autoscaler container.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
SecurityContext defines the security options the container should be run with.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process
The capabilities to add/drop when running containers.
Added capabilities
Removed capabilities
Run container in privileged mode.
procMount denotes the type of proc mount to use for the containers.
Whether this container has a read-only root filesystem. Default is false.
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to the container.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by this container.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
UpscalingMode is "Conservative", "Default", or "Aggressive.
EnableInTreeAutoscaling indicates whether operator should create in tree autoscaling configs
INSERT ADDITIONAL SPEC FIELDS - desired state of cluster Important: Run "make" to regenerate code af
EnableIngress indicates whether operator should create ingress object for head service or not.
RayStartParams are the params of the start command: node-manager-port, object-store-memory, ...
HeadGroupSpec.Replicas is deprecated and ignored; there can only be one head pod per Ray cluster.
ServiceType is Kubernetes service type of the head service.
Template is the eaxct pod template used in K8s depoyments, statefulsets, etc.
Standard object's metadata. More info: https://git.k8s.
Specification of the desired behavior of the pod. More info: https://git.k8s.
Optional duration in seconds the pod may be active on the node relative to StartTime before the syst
If specified, the pod's scheduling constraints
Describes node affinity scheduling rules for the pod.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified
A node selector term, associated with the corresponding weight.
A list of node selector requirements by node's labels.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
A list of node selector requirements by node's fields.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
If the affinity requirements specified by this field are not met at scheduling time, the pod will no
Required. A list of node selector terms. The terms are ORed.
A list of node selector requirements by node's labels.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
A list of node selector requirements by node's fields.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified
Required. A pod affinity term, associated with the corresponding weight.
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
If the affinity requirements specified by this field are not met at scheduling time, the pod will no
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
Describes pod anti-affinity scheduling rules (e.g.
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions speci
Required. A pod affinity term, associated with the corresponding weight.
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod wi
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
AutomountServiceAccountToken indicates whether a service account token should be automatically mount
List of containers belonging to the pod. Containers cannot currently be added or removed.
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Entrypoint array. Not executed within a shell.
List of environment variables to set in the container. Cannot be updated.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in t
Source for the environment variable's value. Cannot be used if value is not empty.
Selects a key of a ConfigMap.
The key to select.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its key must be defined
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
Selects a key of a secret in the pod's namespace
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
List of sources to populate environment variables in the container.
The ConfigMap to select from
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap must be defined
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
The Secret to select from
Name of the referent. More info: https://kubernetes.
Specify whether the Secret must be defined
Docker image name. More info: https://kubernetes.
Image pull policy. One of Always, Never, IfNotPresent.
Actions that the management system should take in response to container lifecycle events.
PostStart is called immediately after a container is created.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
PreStop is called immediately before a container is terminated due to an API request or management e
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Periodic probe of container liveness. Container will be restarted if the probe fails.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Name of the container specified as a DNS_LABEL.
List of ports to expose from the container.
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
What host IP to bind the external port to.
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536.
If specified, this must be an IANA_SVC_NAME and unique within the pod.
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
Periodic probe of container service readiness.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
SecurityContext defines the security options the container should be run with.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process
The capabilities to add/drop when running containers.
Added capabilities
Removed capabilities
Run container in privileged mode.
procMount denotes the type of proc mount to use for the containers.
Whether this container has a read-only root filesystem. Default is false.
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to the container.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by this container.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
StartupProbe indicates that the Pod has successfully initialized.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Whether this container should allocate a buffer for stdin in the container runtime.
Whether the container runtime should close the stdin channel after it has been opened by a single at
Optional: Path at which the file to which the container's termination message will be written is mou
Indicate how the termination message should be populated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
volumeDevices is the list of block devices to be used by the container.
devicePath is the path inside of the container that the device will be mapped to.
name must match the name of a persistentVolumeClaim in the pod
Pod volumes to mount into the container's filesystem. Cannot be updated.
Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation determines how mounts are propagated from the host to container and the other way a
This must match the Name of a Volume.
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
Path within the volume from which the container's volume should be mounted.
Expanded path within the volume from which the container's volume should be mounted.
Container's working directory.
Specifies the DNS parameters of a pod.
A list of DNS name server IP addresses.
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy.
Required.
A list of DNS search domains for host-name lookup.
Set DNS policy for the pod. Defaults to "ClusterFirst".
EnableServiceLinks indicates whether information about services should be injected into pod's enviro
List of ephemeral containers run in this pod.
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Entrypoint array. Not executed within a shell.
List of environment variables to set in the container. Cannot be updated.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in t
Source for the environment variable's value. Cannot be used if value is not empty.
Selects a key of a ConfigMap.
The key to select.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its key must be defined
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
Selects a key of a secret in the pod's namespace
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
List of sources to populate environment variables in the container.
The ConfigMap to select from
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap must be defined
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
The Secret to select from
Name of the referent. More info: https://kubernetes.
Specify whether the Secret must be defined
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
Image pull policy. One of Always, Never, IfNotPresent.
Lifecycle is not allowed for ephemeral containers.
PostStart is called immediately after a container is created.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
PreStop is called immediately before a container is terminated due to an API request or management e
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Probes are not allowed for ephemeral containers.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Name of the ephemeral container specified as a DNS_LABEL.
Ports are not allowed for ephemeral containers.
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
What host IP to bind the external port to.
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536.
If specified, this must be an IANA_SVC_NAME and unique within the pod.
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
Probes are not allowed for ephemeral containers.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Resources are not allowed for ephemeral containers.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
Optional: SecurityContext defines the security options the ephemeral container should be run with.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process
The capabilities to add/drop when running containers.
Added capabilities
Removed capabilities
Run container in privileged mode.
procMount denotes the type of proc mount to use for the containers.
Whether this container has a read-only root filesystem. Default is false.
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to the container.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by this container.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
Probes are not allowed for ephemeral containers.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Whether this container should allocate a buffer for stdin in the container runtime.
Whether the container runtime should close the stdin channel after it has been opened by a single at
If set, the name of the container from PodSpec that this ephemeral container targets.
Optional: Path at which the file to which the container's termination message will be written is mou
Indicate how the termination message should be populated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
volumeDevices is the list of block devices to be used by the container.
devicePath is the path inside of the container that the device will be mapped to.
name must match the name of a persistentVolumeClaim in the pod
Pod volumes to mount into the container's filesystem.
Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation determines how mounts are propagated from the host to container and the other way a
This must match the Name of a Volume.
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
Path within the volume from which the container's volume should be mounted.
Expanded path within the volume from which the container's volume should be mounted.
Container's working directory.
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if
Hostnames for the above IP address.
IP address of the host file entry.
Use the host's ipc namespace. Optional: Default to false.
Host networking requested for this pod. Use the host's network namespace.
Use the host's pid namespace. Optional: Default to false.
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defin
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulli
Name of the referent. More info: https://kubernetes.
List of initialization containers belonging to the pod.
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Entrypoint array. Not executed within a shell.
List of environment variables to set in the container. Cannot be updated.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in t
Source for the environment variable's value. Cannot be used if value is not empty.
Selects a key of a ConfigMap.
The key to select.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its key must be defined
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
Selects a key of a secret in the pod's namespace
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
List of sources to populate environment variables in the container.
The ConfigMap to select from
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap must be defined
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
The Secret to select from
Name of the referent. More info: https://kubernetes.
Specify whether the Secret must be defined
Docker image name. More info: https://kubernetes.
Image pull policy. One of Always, Never, IfNotPresent.
Actions that the management system should take in response to container lifecycle events.
PostStart is called immediately after a container is created.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
PreStop is called immediately before a container is terminated due to an API request or management e
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Periodic probe of container liveness. Container will be restarted if the probe fails.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Name of the container specified as a DNS_LABEL.
List of ports to expose from the container.
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
What host IP to bind the external port to.
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536.
If specified, this must be an IANA_SVC_NAME and unique within the pod.
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
Periodic probe of container service readiness.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
SecurityContext defines the security options the container should be run with.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process
The capabilities to add/drop when running containers.
Added capabilities
Removed capabilities
Run container in privileged mode.
procMount denotes the type of proc mount to use for the containers.
Whether this container has a read-only root filesystem. Default is false.
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to the container.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by this container.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
StartupProbe indicates that the Pod has successfully initialized.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Whether this container should allocate a buffer for stdin in the container runtime.
Whether the container runtime should close the stdin channel after it has been opened by a single at
Optional: Path at which the file to which the container's termination message will be written is mou
Indicate how the termination message should be populated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
volumeDevices is the list of block devices to be used by the container.
devicePath is the path inside of the container that the device will be mapped to.
name must match the name of a persistentVolumeClaim in the pod
Pod volumes to mount into the container's filesystem. Cannot be updated.
Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation determines how mounts are propagated from the host to container and the other way a
This must match the Name of a Volume.
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
Path within the volume from which the container's volume should be mounted.
Expanded path within the volume from which the container's volume should be mounted.
Container's working directory.
NodeName is a request to schedule this pod onto a specific node.
NodeSelector is a selector which must be true for the pod to fit on a node.
Specifies the OS of the containers in the pod.
Name is the name of the operating system. The currently supported values are linux and windows.
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
PreemptionPolicy is the Policy for preempting pods with lower priority.
The priority value. Various system components use this field to find the priority of the pod.
If specified, indicates the pod's priority.
If specified, all readiness gates will be evaluated for pod readiness.
ConditionType refers to a condition in the pod's condition list with matching type.
Restart policy for all containers within the pod. One of Always, OnFailure, Never.
RuntimeClassName refers to a RuntimeClass object in the node.k8s.
If specified, the pod will be dispatched by specified scheduler.
SecurityContext holds pod-level security attributes and common container settings.
A special supplemental group that applies to all containers in a pod.
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to all containers.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by the containers in this pod.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
A list of groups applied to the first process run in each container, in addition to the container's
Sysctls hold a list of namespaced sysctls used for the pod.
Name of a property to set
Value of a property to set
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.
ServiceAccountName is the name of the ServiceAccount to use to run this pod.
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the defa
Share a single process namespace between all of the containers in a pod.
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.
Optional duration in seconds the pod needs to terminate gracefully.
If specified, the pod's tolerations.
Effect indicates the taint effect to match. Empty means match all taint effects.
Key is the taint key that the toleration applies to. Empty means match all taint keys.
Operator represents a key's relationship to the value. Valid operators are Exists and Equal.
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, o
Value is the taint value the toleration matches to.
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.
LabelSelector is used to find matching pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
MaxSkew describes the degree to which pods may be unevenly distributed.
TopologyKey is the key of node labels.
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
List of volumes that can be mounted by containers belonging to the pod.
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine an
Filesystem type of the volume that you want to mount.
The partition in the volume that you want to mount.
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Host Caching mode: None, Read Only, Read Write.
The Name of the data disk in the blob storage
The URI the data disk in the blob storage
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per sto
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
the name of secret that contains Azure Storage Account Name and Key
Share Name
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.
Optional: Used as the mounted root, rather than the full Ceph tree, default is /
Optional: Defaults to false (read/write).
Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.
Optional: SecretRef is reference to the authentication secret for User, default is empty.
Name of the referent. More info: https://kubernetes.
Optional: User is the rados user name, default is admin More info: https://examples.k8s.
Cinder represents a cinder volume attached and mounted on kubelets host machine.
Filesystem type to mount. Must be a filesystem type supported by the host operating system.
Optional: Defaults to false (read/write).
Optional: points to a secret object containing parameters used to connect to OpenStack.
Name of the referent. More info: https://kubernetes.
volume id used to identify the volume in cinder. More info: https://examples.k8s.
ConfigMap represents a configMap that should populate this volume
Optional: mode bits used to set permissions on created files by default.
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its keys must be defined
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external C
Driver is the name of the CSI driver that handles this volume.
Filesystem type to mount. Ex. "ext4", "xfs", "ntfs".
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to
Name of the referent. More info: https://kubernetes.
Specifies a read-only configuration for the volume. Defaults to false (read/write).
VolumeAttributes stores driver-specific properties that are passed to the CSI driver.
DownwardAPI represents downward API about the pod that should populate this volume
Optional: mode bits to use on created files by default.
Items is a list of downward API volume file
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 07
Required: Path is the relative path name of the file to be created.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
EmptyDir represents a temporary directory that shares a pod's lifetime.
What type of storage medium should back this directory.
Total amount of local storage required for this EmptyDir volume.
Ephemeral represents a volume that is handled by a cluster storage driver.
Will be used to create a stand-alone PVC to provision the volume.
May contain labels and annotations that will be copied into the PVC when creating it.
The specification for the PersistentVolumeClaim.
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.
APIGroup is the group for the resource being referenced.
Kind is the type of resource being referenced
Name is the name of resource being referenced
Specifies the object from which to populate the volume with data, if a non-empty volume is desired.
APIGroup is the group for the resource being referenced.
Kind is the type of resource being referenced
Name is the name of resource being referenced
Resources represents the minimum resources the volume should have.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
A label query over volumes to consider for binding.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
Name of the StorageClass required by the claim. More info: https://kubernetes.
volumeMode defines what type of volume is required by the claim.
VolumeName is the binding reference to the PersistentVolume backing this claim.
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Optional: FC target lun number
Optional: Defaults to false (read/write).
Optional: FC target worldwide names (WWNs)
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plu
Driver is the name of the driver to use for this volume.
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Optional: Extra command options if any.
Optional: Defaults to false (read/write).
Optional: SecretRef is reference to the secret object containing sensitive information to pass to th
Name of the referent. More info: https://kubernetes.
Flocker represents a Flocker volume attached to a kubelet's host machine.
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as de
UUID of the dataset. This is unique identifier of a Flocker dataset
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and th
Filesystem type of the volume that you want to mount.
The partition in the volume that you want to mount.
Unique name of the PD resource in GCE. Used to identify the disk in GCE.
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated.
Target directory name. Must not contain or start with '..'. If '.
Repository URL
Commit hash for the specified revision.
Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to
Path of the directory on the host.
Type for HostPath Volume Defaults to "" More info: https://kubernetes.
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then expose
whether support iSCSI Discovery CHAP authentication
whether support iSCSI Session CHAP authentication
Filesystem type of the volume that you want to mount.
Custom iSCSI Initiator Name.
Target iSCSI Qualified Name.
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
iSCSI Target Lun number.
iSCSI Target Portal List.
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
CHAP Secret for iSCSI target and initiator authentication
Name of the referent. More info: https://kubernetes.
iSCSI Target Portal.
Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.
NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.
Path that is exported by the NFS server. More info: https://kubernetes.
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false.
Server is the hostname or IP address of the NFS server. More info: https://kubernetes.
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same name
ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
Will force the ReadOnly setting in VolumeMounts. Default false.
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
ID that identifies Photon Controller persistent disk
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
FSType represents the filesystem type to mount Must be a filesystem type supported by the host opera
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
VolumeID uniquely identifies a Portworx volume
Items for all in one resources secrets, configmaps, and downward API
Mode bits used to set permissions on created files by default.
list of volume projections
information about the configMap data to project
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its keys must be defined
information about the downwardAPI data to project
Items is a list of DownwardAPIVolume file
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 07
Required: Path is the relative path name of the file to be created.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
information about the secret data to project
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected int
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
information about the serviceAccountToken data to project
Audience is the intended audience of the token.
ExpirationSeconds is the requested duration of validity of the service account token.
Path is the path relative to the mount point of the file to project the token into.
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
Group to map volume access to Default is no group
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.
Registry represents a single or multiple Quobyte Registry services specified as a string as host:por
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volu
User to map volume access to Defaults to serivceaccount user
Volume is a string that references an already created Quobyte volume by name.
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.
Filesystem type of the volume that you want to mount.
The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring.
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring.
Name of the referent. More info: https://kubernetes.
The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
The host address of the ScaleIO API Gateway.
The name of the ScaleIO Protection Domain for the configured storage.
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
SecretRef references to the secret for ScaleIO user and other sensitive information.
Name of the referent. More info: https://kubernetes.
Flag to enable/disable SSL communication with Gateway, default false
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
The ScaleIO Storage Pool associated with the protection domain.
The name of the storage system as configured in ScaleIO.
The name of a volume already created in the ScaleIO system that is associated with this volume sourc
Secret represents a secret that should populate this volume. More info: https://kubernetes.
Optional: mode bits used to set permissions on created files by default.
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected int
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Specify whether the Secret or its keys must be defined
Name of the secret in the pod's namespace to use. More info: https://kubernetes.
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
SecretRef specifies the secret to use for obtaining the StorageOS API credentials.
Name of the referent. More info: https://kubernetes.
VolumeName is the human-readable name of the StorageOS volume.
VolumeNamespace specifies the scope of the volume within StorageOS.
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
Storage Policy Based Management (SPBM) profile name.
Path that identifies vSphere volume vmdk
RayVersion is the version of ray being used. This determines the autoscaler's image version.
WorkerGroupSpecs are the specs for the worker pods
we can have multiple worker groups, we distinguish them by name
MaxReplicas defaults to maxInt32
MinReplicas defaults to 1
RayStartParams are the params of the start command: address, object-store-memory, ...
Replicas Number of desired pods in this pod group.
ScaleStrategy defines which pods to remove
WorkersToDelete workers to be deleted
Template is a pod template for the worker
Standard object's metadata. More info: https://git.k8s.
Specification of the desired behavior of the pod. More info: https://git.k8s.
Optional duration in seconds the pod may be active on the node relative to StartTime before the syst
If specified, the pod's scheduling constraints
Describes node affinity scheduling rules for the pod.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified
A node selector term, associated with the corresponding weight.
A list of node selector requirements by node's labels.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
A list of node selector requirements by node's fields.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
If the affinity requirements specified by this field are not met at scheduling time, the pod will no
Required. A list of node selector terms. The terms are ORed.
A list of node selector requirements by node's labels.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
A list of node selector requirements by node's fields.
The label key that the selector applies to.
Represents a key's relationship to a set of values.
An array of string values. If the operator is In or NotIn, the values array must be non-empty.
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc.
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified
Required. A pod affinity term, associated with the corresponding weight.
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
If the affinity requirements specified by this field are not met at scheduling time, the pod will no
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
Describes pod anti-affinity scheduling rules (e.g.
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions speci
Required. A pod affinity term, associated with the corresponding weight.
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod wi
A label query over a set of resources, in this case pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
A label query over the set of namespaces that the term applies to.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
namespaces specifies a static list of namespace names that the term applies to.
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching th
AutomountServiceAccountToken indicates whether a service account token should be automatically mount
List of containers belonging to the pod. Containers cannot currently be added or removed.
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Entrypoint array. Not executed within a shell.
List of environment variables to set in the container. Cannot be updated.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in t
Source for the environment variable's value. Cannot be used if value is not empty.
Selects a key of a ConfigMap.
The key to select.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its key must be defined
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
Selects a key of a secret in the pod's namespace
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
List of sources to populate environment variables in the container.
The ConfigMap to select from
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap must be defined
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
The Secret to select from
Name of the referent. More info: https://kubernetes.
Specify whether the Secret must be defined
Docker image name. More info: https://kubernetes.
Image pull policy. One of Always, Never, IfNotPresent.
Actions that the management system should take in response to container lifecycle events.
PostStart is called immediately after a container is created.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
PreStop is called immediately before a container is terminated due to an API request or management e
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Periodic probe of container liveness. Container will be restarted if the probe fails.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Name of the container specified as a DNS_LABEL.
List of ports to expose from the container.
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
What host IP to bind the external port to.
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536.
If specified, this must be an IANA_SVC_NAME and unique within the pod.
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
Periodic probe of container service readiness.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
SecurityContext defines the security options the container should be run with.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process
The capabilities to add/drop when running containers.
Added capabilities
Removed capabilities
Run container in privileged mode.
procMount denotes the type of proc mount to use for the containers.
Whether this container has a read-only root filesystem. Default is false.
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to the container.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by this container.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
StartupProbe indicates that the Pod has successfully initialized.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Whether this container should allocate a buffer for stdin in the container runtime.
Whether the container runtime should close the stdin channel after it has been opened by a single at
Optional: Path at which the file to which the container's termination message will be written is mou
Indicate how the termination message should be populated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
volumeDevices is the list of block devices to be used by the container.
devicePath is the path inside of the container that the device will be mapped to.
name must match the name of a persistentVolumeClaim in the pod
Pod volumes to mount into the container's filesystem. Cannot be updated.
Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation determines how mounts are propagated from the host to container and the other way a
This must match the Name of a Volume.
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
Path within the volume from which the container's volume should be mounted.
Expanded path within the volume from which the container's volume should be mounted.
Container's working directory.
Specifies the DNS parameters of a pod.
A list of DNS name server IP addresses.
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy.
Required.
A list of DNS search domains for host-name lookup.
Set DNS policy for the pod. Defaults to "ClusterFirst".
EnableServiceLinks indicates whether information about services should be injected into pod's enviro
List of ephemeral containers run in this pod.
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Entrypoint array. Not executed within a shell.
List of environment variables to set in the container. Cannot be updated.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in t
Source for the environment variable's value. Cannot be used if value is not empty.
Selects a key of a ConfigMap.
The key to select.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its key must be defined
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
Selects a key of a secret in the pod's namespace
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
List of sources to populate environment variables in the container.
The ConfigMap to select from
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap must be defined
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
The Secret to select from
Name of the referent. More info: https://kubernetes.
Specify whether the Secret must be defined
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
Image pull policy. One of Always, Never, IfNotPresent.
Lifecycle is not allowed for ephemeral containers.
PostStart is called immediately after a container is created.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
PreStop is called immediately before a container is terminated due to an API request or management e
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Probes are not allowed for ephemeral containers.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Name of the ephemeral container specified as a DNS_LABEL.
Ports are not allowed for ephemeral containers.
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
What host IP to bind the external port to.
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536.
If specified, this must be an IANA_SVC_NAME and unique within the pod.
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
Probes are not allowed for ephemeral containers.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Resources are not allowed for ephemeral containers.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
Optional: SecurityContext defines the security options the ephemeral container should be run with.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process
The capabilities to add/drop when running containers.
Added capabilities
Removed capabilities
Run container in privileged mode.
procMount denotes the type of proc mount to use for the containers.
Whether this container has a read-only root filesystem. Default is false.
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to the container.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by this container.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
Probes are not allowed for ephemeral containers.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Whether this container should allocate a buffer for stdin in the container runtime.
Whether the container runtime should close the stdin channel after it has been opened by a single at
If set, the name of the container from PodSpec that this ephemeral container targets.
Optional: Path at which the file to which the container's termination message will be written is mou
Indicate how the termination message should be populated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
volumeDevices is the list of block devices to be used by the container.
devicePath is the path inside of the container that the device will be mapped to.
name must match the name of a persistentVolumeClaim in the pod
Pod volumes to mount into the container's filesystem.
Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation determines how mounts are propagated from the host to container and the other way a
This must match the Name of a Volume.
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
Path within the volume from which the container's volume should be mounted.
Expanded path within the volume from which the container's volume should be mounted.
Container's working directory.
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if
Hostnames for the above IP address.
IP address of the host file entry.
Use the host's ipc namespace. Optional: Default to false.
Host networking requested for this pod. Use the host's network namespace.
Use the host's pid namespace. Optional: Default to false.
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defin
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulli
Name of the referent. More info: https://kubernetes.
List of initialization containers belonging to the pod.
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
Entrypoint array. Not executed within a shell.
List of environment variables to set in the container. Cannot be updated.
Name of the environment variable. Must be a C_IDENTIFIER.
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in t
Source for the environment variable's value. Cannot be used if value is not empty.
Selects a key of a ConfigMap.
The key to select.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its key must be defined
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
Selects a key of a secret in the pod's namespace
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
List of sources to populate environment variables in the container.
The ConfigMap to select from
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap must be defined
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
The Secret to select from
Name of the referent. More info: https://kubernetes.
Specify whether the Secret must be defined
Docker image name. More info: https://kubernetes.
Image pull policy. One of Always, Never, IfNotPresent.
Actions that the management system should take in response to container lifecycle events.
PostStart is called immediately after a container is created.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
PreStop is called immediately before a container is terminated due to an API request or management e
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Deprecated.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Periodic probe of container liveness. Container will be restarted if the probe fails.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Name of the container specified as a DNS_LABEL.
List of ports to expose from the container.
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
What host IP to bind the external port to.
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536.
If specified, this must be an IANA_SVC_NAME and unique within the pod.
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
Periodic probe of container service readiness.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
SecurityContext defines the security options the container should be run with.
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process
The capabilities to add/drop when running containers.
Added capabilities
Removed capabilities
Run container in privileged mode.
procMount denotes the type of proc mount to use for the containers.
Whether this container has a read-only root filesystem. Default is false.
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to the container.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by this container.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
StartupProbe indicates that the Pod has successfully initialized.
Exec specifies the action to take.
Command is the command line to execute inside the container, the working directory for the command
Minimum consecutive failures for the probe to be considered failed after having succeeded.
GRPC specifies an action involving a GRPC port.
Port number of the gRPC service. Number must be in the range 1 to 65535.
Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.
HTTPGet specifies the http request to perform.
Host name to connect to, defaults to the pod IP.
Custom headers to set in the request. HTTP allows repeated headers.
The header field name
The header field value
Path to access on the HTTP server.
Name or number of the port to access on the container. Number must be in the range 1 to 65535.
Scheme to use for connecting to the host. Defaults to HTTP.
Number of seconds after the container has started before liveness probes are initiated.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
Minimum consecutive successes for the probe to be considered successful after having failed.
TCPSocket specifies an action involving a TCP port.
Optional: Host name to connect to, defaults to the pod IP.
Number or name of the port to access on the container. Number must be in the range 1 to 65535.
Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
Whether this container should allocate a buffer for stdin in the container runtime.
Whether the container runtime should close the stdin channel after it has been opened by a single at
Optional: Path at which the file to which the container's termination message will be written is mou
Indicate how the termination message should be populated.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
volumeDevices is the list of block devices to be used by the container.
devicePath is the path inside of the container that the device will be mapped to.
name must match the name of a persistentVolumeClaim in the pod
Pod volumes to mount into the container's filesystem. Cannot be updated.
Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation determines how mounts are propagated from the host to container and the other way a
This must match the Name of a Volume.
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
Path within the volume from which the container's volume should be mounted.
Expanded path within the volume from which the container's volume should be mounted.
Container's working directory.
NodeName is a request to schedule this pod onto a specific node.
NodeSelector is a selector which must be true for the pod to fit on a node.
Specifies the OS of the containers in the pod.
Name is the name of the operating system. The currently supported values are linux and windows.
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
PreemptionPolicy is the Policy for preempting pods with lower priority.
The priority value. Various system components use this field to find the priority of the pod.
If specified, indicates the pod's priority.
If specified, all readiness gates will be evaluated for pod readiness.
ConditionType refers to a condition in the pod's condition list with matching type.
Restart policy for all containers within the pod. One of Always, OnFailure, Never.
RuntimeClassName refers to a RuntimeClass object in the node.k8s.
If specified, the pod will be dispatched by specified scheduler.
SecurityContext holds pod-level security attributes and common container settings.
A special supplemental group that applies to all containers in a pod.
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being
The GID to run the entrypoint of the container process. Uses runtime default if unset.
Indicates that the container must run as a non-root user.
The UID to run the entrypoint of the container process.
The SELinux context to be applied to all containers.
Level is SELinux level label that applies to the container.
Role is a SELinux role label that applies to the container.
Type is a SELinux type label that applies to the container.
User is a SELinux user label that applies to the container.
The seccomp options to use by the containers in this pod.
localhostProfile indicates a profile defined in a file on the node should be used.
type indicates which kind of seccomp profile will be applied.
A list of groups applied to the first process run in each container, in addition to the container's
Sysctls hold a list of namespaced sysctls used for the pod.
Name of a property to set
Value of a property to set
The Windows specific settings applied to all containers.
GMSACredentialSpec is where the GMSA admission webhook (https://github.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
HostProcess determines if a container should be run as a 'Host Process' container.
The UserName in Windows to run the entrypoint of the container process.
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.
ServiceAccountName is the name of the ServiceAccount to use to run this pod.
If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the defa
Share a single process namespace between all of the containers in a pod.
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.
Optional duration in seconds the pod needs to terminate gracefully.
If specified, the pod's tolerations.
Effect indicates the taint effect to match. Empty means match all taint effects.
Key is the taint key that the toleration applies to. Empty means match all taint keys.
Operator represents a key's relationship to the value. Valid operators are Exists and Equal.
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, o
Value is the taint value the toleration matches to.
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.
LabelSelector is used to find matching pods.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
MaxSkew describes the degree to which pods may be unevenly distributed.
TopologyKey is the key of node labels.
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
List of volumes that can be mounted by containers belonging to the pod.
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine an
Filesystem type of the volume that you want to mount.
The partition in the volume that you want to mount.
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Host Caching mode: None, Read Only, Read Write.
The Name of the data disk in the blob storage
The URI the data disk in the blob storage
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per sto
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
the name of secret that contains Azure Storage Account Name and Key
Share Name
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.
Optional: Used as the mounted root, rather than the full Ceph tree, default is /
Optional: Defaults to false (read/write).
Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.
Optional: SecretRef is reference to the authentication secret for User, default is empty.
Name of the referent. More info: https://kubernetes.
Optional: User is the rados user name, default is admin More info: https://examples.k8s.
Cinder represents a cinder volume attached and mounted on kubelets host machine.
Filesystem type to mount. Must be a filesystem type supported by the host operating system.
Optional: Defaults to false (read/write).
Optional: points to a secret object containing parameters used to connect to OpenStack.
Name of the referent. More info: https://kubernetes.
volume id used to identify the volume in cinder. More info: https://examples.k8s.
ConfigMap represents a configMap that should populate this volume
Optional: mode bits used to set permissions on created files by default.
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its keys must be defined
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external C
Driver is the name of the CSI driver that handles this volume.
Filesystem type to mount. Ex. "ext4", "xfs", "ntfs".
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to
Name of the referent. More info: https://kubernetes.
Specifies a read-only configuration for the volume. Defaults to false (read/write).
VolumeAttributes stores driver-specific properties that are passed to the CSI driver.
DownwardAPI represents downward API about the pod that should populate this volume
Optional: mode bits to use on created files by default.
Items is a list of downward API volume file
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 07
Required: Path is the relative path name of the file to be created.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
EmptyDir represents a temporary directory that shares a pod's lifetime.
What type of storage medium should back this directory.
Total amount of local storage required for this EmptyDir volume.
Ephemeral represents a volume that is handled by a cluster storage driver.
Will be used to create a stand-alone PVC to provision the volume.
May contain labels and annotations that will be copied into the PVC when creating it.
The specification for the PersistentVolumeClaim.
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.
APIGroup is the group for the resource being referenced.
Kind is the type of resource being referenced
Name is the name of resource being referenced
Specifies the object from which to populate the volume with data, if a non-empty volume is desired.
APIGroup is the group for the resource being referenced.
Kind is the type of resource being referenced
Name is the name of resource being referenced
Resources represents the minimum resources the volume should have.
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.
Requests describes the minimum amount of compute resources required.
A label query over volumes to consider for binding.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values.
values is an array of string values.
matchLabels is a map of {key,value} pairs.
Name of the StorageClass required by the claim. More info: https://kubernetes.
volumeMode defines what type of volume is required by the claim.
VolumeName is the binding reference to the PersistentVolume backing this claim.
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Optional: FC target lun number
Optional: Defaults to false (read/write).
Optional: FC target worldwide names (WWNs)
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plu
Driver is the name of the driver to use for this volume.
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Optional: Extra command options if any.
Optional: Defaults to false (read/write).
Optional: SecretRef is reference to the secret object containing sensitive information to pass to th
Name of the referent. More info: https://kubernetes.
Flocker represents a Flocker volume attached to a kubelet's host machine.
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as de
UUID of the dataset. This is unique identifier of a Flocker dataset
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and th
Filesystem type of the volume that you want to mount.
The partition in the volume that you want to mount.
Unique name of the PD resource in GCE. Used to identify the disk in GCE.
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated.
Target directory name. Must not contain or start with '..'. If '.
Repository URL
Commit hash for the specified revision.
Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to
Path of the directory on the host.
Type for HostPath Volume Defaults to "" More info: https://kubernetes.
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then expose
whether support iSCSI Discovery CHAP authentication
whether support iSCSI Session CHAP authentication
Filesystem type of the volume that you want to mount.
Custom iSCSI Initiator Name.
Target iSCSI Qualified Name.
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
iSCSI Target Lun number.
iSCSI Target Portal List.
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
CHAP Secret for iSCSI target and initiator authentication
Name of the referent. More info: https://kubernetes.
iSCSI Target Portal.
Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.
NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.
Path that is exported by the NFS server. More info: https://kubernetes.
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false.
Server is the hostname or IP address of the NFS server. More info: https://kubernetes.
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same name
ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
Will force the ReadOnly setting in VolumeMounts. Default false.
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
ID that identifies Photon Controller persistent disk
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
FSType represents the filesystem type to mount Must be a filesystem type supported by the host opera
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
VolumeID uniquely identifies a Portworx volume
Items for all in one resources secrets, configmaps, and downward API
Mode bits used to set permissions on created files by default.
list of volume projections
information about the configMap data to project
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Name of the referent. More info: https://kubernetes.
Specify whether the ConfigMap or its keys must be defined
information about the downwardAPI data to project
Items is a list of DownwardAPIVolume file
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Version of the schema the FieldPath is written in terms of, defaults to "v1".
Path of the field to select in the specified API version.
Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 07
Required: Path is the relative path name of the file to be created.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.
Container name: required for volumes, optional for env vars
Specifies the output format of the exposed resources, defaults to "1"
Required: resource to select
information about the secret data to project
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected int
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Name of the referent. More info: https://kubernetes.
Specify whether the Secret or its key must be defined
information about the serviceAccountToken data to project
Audience is the intended audience of the token.
ExpirationSeconds is the requested duration of validity of the service account token.
Path is the path relative to the mount point of the file to project the token into.
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
Group to map volume access to Default is no group
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.
Registry represents a single or multiple Quobyte Registry services specified as a string as host:por
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volu
User to map volume access to Defaults to serivceaccount user
Volume is a string that references an already created Quobyte volume by name.
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.
Filesystem type of the volume that you want to mount.
The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring.
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring.
Name of the referent. More info: https://kubernetes.
The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
The host address of the ScaleIO API Gateway.
The name of the ScaleIO Protection Domain for the configured storage.
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
SecretRef references to the secret for ScaleIO user and other sensitive information.
Name of the referent. More info: https://kubernetes.
Flag to enable/disable SSL communication with Gateway, default false
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
The ScaleIO Storage Pool associated with the protection domain.
The name of the storage system as configured in ScaleIO.
The name of a volume already created in the ScaleIO system that is associated with this volume sourc
Secret represents a secret that should populate this volume. More info: https://kubernetes.
Optional: mode bits used to set permissions on created files by default.
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected int
The key to project.
Optional: mode bits used to set permissions on this file.
The relative path of the file to map the key to. May not be an absolute path.
Specify whether the Secret or its keys must be defined
Name of the secret in the pod's namespace to use. More info: https://kubernetes.
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
SecretRef specifies the secret to use for obtaining the StorageOS API credentials.
Name of the referent. More info: https://kubernetes.
VolumeName is the human-readable name of the StorageOS volume.
VolumeNamespace specifies the scope of the volume within StorageOS.
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex.
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
Storage Policy Based Management (SPBM) profile name.
Path that identifies vSphere volume vmdk
Important: Run "make" to regenerate code after modifying this file
RayActorOptionSpec defines the desired state of RayActor
RayServiceStatuses defines the observed state of RayService
Important: Run "make" to regenerate code after modifying this file
Keep track of how long the service is healthy.
DashboardStatus defines the current states of Ray Dashboard
Keep track of how long the dashboard is healthy.
RayClusterStatus defines the observed state of RayCluster
AvailableWorkerReplicas indicates how many replicas are available in the cluster
DesiredWorkerReplicas indicates overall desired replicas claimed by the user at the cluster level.
Service Endpoints
Head info
LastUpdateTime indicates last update timestamp for this cluster status.
MaxWorkerReplicas indicates sum of maximum replicas of each node group.
MinWorkerReplicas indicates sum of minimum replicas of each node group.
observedGeneration is the most recent generation observed for this RayCluster.
Reason provides more information about current State
INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerat
Keep track of how long the service is healthy.
Name, Status, Message are from Ray Dashboard and represent a Serve deployment's state.
TODO: change status type to enum
observedGeneration is the most recent generation observed for this RayService.
Pending Service Status indicates a RayCluster will be created or is being created.
Important: Run "make" to regenerate code after modifying this file
Keep track of how long the service is healthy.
DashboardStatus defines the current states of Ray Dashboard
Keep track of how long the dashboard is healthy.
RayClusterStatus defines the observed state of RayCluster
AvailableWorkerReplicas indicates how many replicas are available in the cluster
DesiredWorkerReplicas indicates overall desired replicas claimed by the user at the cluster level.
Service Endpoints
Head info
LastUpdateTime indicates last update timestamp for this cluster status.
MaxWorkerReplicas indicates sum of maximum replicas of each node group.
MinWorkerReplicas indicates sum of minimum replicas of each node group.
observedGeneration is the most recent generation observed for this RayCluster.
Reason provides more information about current State
INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerat
Keep track of how long the service is healthy.
Name, Status, Message are from Ray Dashboard and represent a Serve deployment's state.
TODO: change status type to enum
ServiceStatus indicates the current RayService status.
Source: ray.io_rayservices.yaml
Changes to RayService (ray.io/v1alpha1) in each Kuberay version, compared to the version before it.
4 properties have been added
1 property is no longer required
1 property has changed the description
Released · View RayService in v0.5.0
5 properties have been added
3 properties have changed the description
Released · View RayService in v0.4.0
RayService was first seen on this version of Kuberay
Released · View RayService in v0.3.0
No examples of RayService yet. Contribute one on GitHub.
kubespec.dev