com.coralogix.zio.k8s.model.core.v1

Represents a Persistent Disk resource in AWS.

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

Value Params

fsType: Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partition: The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
readOnly: Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID: Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Companion

object

Companion: class

Affinity is a group of affinity scheduling rules.

Companion: object

Companion: class

AttachedVolume describes a volume attached to a node

Value Params

devicePath: DevicePath represents the device path where the volume should be available
name: Name of the attached volume

Companion

object

Companion: class

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Value Params

cachingMode: Host Caching mode: None, Read Only, Read Write.
diskName: The Name of the data disk in the blob storage
diskURI: The URI the data disk in the blob storage
fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
kind: Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Companion

object

Companion: class

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Value Params

readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName: the name of secret that contains Azure Storage Account Name and Key
secretNamespace: the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
shareName: Share Name

Companion

object

Companion: class

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Value Params

readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName: the name of secret that contains Azure Storage Account Name and Key
shareName: Share Name

Companion

object

Companion: class

Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.

Companion: object

Companion: class

Represents storage that is managed by an external CSI volume driver (Beta feature)

Value Params

driver: Driver is the name of the driver to use for this volume. Required.
fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
readOnly: Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
volumeAttributes: Attributes of the volume to publish.
volumeHandle: VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

Companion

object

Companion: class

Represents a source location of a volume to mount, managed by an external CSI driver

Value Params

driver: Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
fsType: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
readOnly: Specifies a read-only configuration for the volume. Defaults to false (read/write).
volumeAttributes: VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

Companion

object

Companion: class

Adds and removes POSIX capabilities from running containers.

Value Params

add: Added capabilities
drop: Removed capabilities

Companion

object

Companion: class

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Value Params

monitors: Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
path: Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretFile: Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
user: Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Companion

object

Companion: class

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Value Params

monitors: Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
path: Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretFile: Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
user: Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Companion

object

Companion: class

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
volumeID: volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Companion

object

Companion: class

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
volumeID: volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Companion

object

Companion: class

ClientIPConfig represents the configurations of Client IP based session affinity.

Value Params

timeoutSeconds: timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

Companion

object

Companion: class

Information about the condition of a component.

Value Params

error: Condition error code for a component. For example, a health check error code.
message: Message about the condition for a component. For example, information about a health check.
status: Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
type: Type of condition for a component. Valid value: "Healthy"

Companion

object

Companion: class

ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+

Value Params

conditions: List of component conditions observed

Companion

object

Companion: class

ConfigMap holds configuration data for pods to consume.

Value Params

binaryData: BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
data: Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
immutable: Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate.

Companion

object

Companion: class

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.

The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Value Params

name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional: Specify whether the ConfigMap must be defined

Companion

object

Companion: class

Selects a key from a ConfigMap.

Value Params

key: The key to select.
name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional: Specify whether the ConfigMap or its key must be defined

Companion

object

Companion: class

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

Value Params

kubeletConfigKey: KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name: Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace: Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion: ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid: UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

Companion

object

Companion: class

Adapts a ConfigMap into a projected volume.

The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

Value Params

items: If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional: Specify whether the ConfigMap or its keys must be defined

Companion

object

Companion: class

Adapts a ConfigMap into a volume.

The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

Value Params

defaultMode: Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items: If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional: Specify whether the ConfigMap or its keys must be defined

Companion

object

Companion: class

case class Container(args: Optional[Vector[String]], command: Optional[Vector[String]], env: Optional[Vector[EnvVar]], envFrom: Optional[Vector[EnvFromSource]], image: Optional[String], imagePullPolicy: Optional[String], lifecycle: Optional[Lifecycle], livenessProbe: Optional[Probe], name: String, ports: Optional[Vector[ContainerPort]], readinessProbe: Optional[Probe], resources: Optional[ResourceRequirements], securityContext: Optional[SecurityContext], startupProbe: Optional[Probe], stdin: Optional[Boolean], stdinOnce: Optional[Boolean], terminationMessagePath: Optional[String], terminationMessagePolicy: Optional[String], tty: Optional[Boolean], volumeDevices: Optional[Vector[VolumeDevice]], volumeMounts: Optional[Vector[VolumeMount]], workingDir: Optional[String])

A single application container that you want to run within a pod.

Value Params

args: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $$(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
command: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $$(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
env: List of environment variables to set in the container. Cannot be updated.
envFrom: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
image: Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
imagePullPolicy: Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
name: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
stdin: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
terminationMessagePath: Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicy: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
tty: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices: volumeDevices is the list of block devices to be used by the container.
volumeMounts: Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDir: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

Companion

object

Companion: class

Describe a container image

Value Params

names: Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
sizeBytes: The size of the image in bytes.

Companion

object

Companion: class

ContainerPort represents a network port in a single container.

Value Params

containerPort: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
hostIP: What host IP to bind the external port to.
hostPort: Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
name: If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

Companion

object

Companion: class

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

Companion: object

Companion: class

ContainerStateRunning is a running state of a container.

Companion: object

Companion: class

ContainerStateTerminated is a terminated state of a container.

Value Params

containerID: Container's ID in the format 'docker://<container_id>'
exitCode: Exit status from the last termination of the container
message: Message regarding the last termination of the container
reason: (brief) reason from the last termination of the container
signal: Signal from the last termination of the container

Companion

object

Companion: class

ContainerStateWaiting is a waiting state of a container.

Value Params

message: Message regarding why the container is not yet running.
reason: (brief) reason the container is not yet running.

Companion

object

Companion: class

ContainerStatus contains details for the current status of this container.

Value Params

containerID: Container's ID in the format 'docker://<container_id>'.
image: The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
imageID: ImageID of the container's image.
name: This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
ready: Specifies whether the container has passed its readiness probe.
restartCount: The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
started: Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.

Companion

object

Companion: class

DaemonEndpoint contains information about a single Daemon endpoint.

Value Params

Port: Port number of the given endpoint.

Companion

object

Companion: class

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

Value Params

items: Items is a list of DownwardAPIVolume file

Companion

object

Companion: class

DownwardAPIVolumeFile represents information to create the file containing the pod field

Value Params

mode: Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path: Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

Companion

object

Companion: class

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Value Params

defaultMode: Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items: Items is a list of downward API volume file

Companion

object

Companion: class

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Value Params

medium: What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Companion

object

Companion: class

EndpointAddress is a tuple that describes single IP address.

Value Params

hostname: The Hostname of this endpoint
ip: The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
nodeName: Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

Companion

object

Companion: class

EndpointPort is a tuple that describes a single port.

Value Params

appProtocol: The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
name: The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
port: The port number of the endpoint.
protocol: The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

Companion

object

Companion: class

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]

Value Params

addresses: IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
notReadyAddresses: IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
ports: Port numbers available on the related IP addresses.

Companion

object

Companion: class

Endpoints is a collection of endpoints that implement the actual service. Example: Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]

Value Params

subsets: The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

Companion

object

Companion: class

EnvFromSource represents the source of a set of ConfigMaps

Value Params

prefix: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

Companion

object

Companion: class

EnvVar represents an environment variable present in a Container.

Value Params

name: Name of the environment variable. Must be a C_IDENTIFIER.
value: Variable references $$(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

Companion

object

Companion: class

EnvVarSource represents a source for the value of an EnvVar.

Companion: object

Companion: class

case class EphemeralContainer(args: Optional[Vector[String]], command: Optional[Vector[String]], env: Optional[Vector[EnvVar]], envFrom: Optional[Vector[EnvFromSource]], image: Optional[String], imagePullPolicy: Optional[String], lifecycle: Optional[Lifecycle], livenessProbe: Optional[Probe], name: String, ports: Optional[Vector[ContainerPort]], readinessProbe: Optional[Probe], resources: Optional[ResourceRequirements], securityContext: Optional[SecurityContext], startupProbe: Optional[Probe], stdin: Optional[Boolean], stdinOnce: Optional[Boolean], targetContainerName: Optional[String], terminationMessagePath: Optional[String], terminationMessagePolicy: Optional[String], tty: Optional[Boolean], volumeDevices: Optional[Vector[VolumeDevice]], volumeMounts: Optional[Vector[VolumeMount]], workingDir: Optional[String])

An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.

Value Params

args: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $$(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
command: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $$(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
env: List of environment variables to set in the container. Cannot be updated.
envFrom: List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
image: Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
imagePullPolicy: Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
name: Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
ports: Ports are not allowed for ephemeral containers.
stdin: Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce: Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
targetContainerName: If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.
terminationMessagePath: Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicy: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
tty: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices: volumeDevices is the list of block devices to be used by the container.
volumeMounts: Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDir: Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

Companion

object

Companion: class

Represents an ephemeral volume that is handled by a normal storage driver.

Value Params

readOnly: Specifies a read-only configuration for the volume. Defaults to false (read/write).

Companion

object

Companion: class

Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.

Value Params

action: What action was taken/failed regarding to the Regarding object.
count: The number of times this event has occurred.
message: A human-readable description of the status of this operation.
reason: This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
reportingComponent: Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
reportingInstance: ID of the controller instance, e.g. kubelet-xyzf.
type: Type of this event (Normal, Warning), new types could be added in the future

Companion

object

Companion: class

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

Value Params

count: Number of occurrences in this series up to the last heartbeat time

Companion

object

Companion: class

EventSource contains information for an event.

Value Params

component: Component from which the event is generated.
host: Node name on which the event is generated.

Companion

object

Companion: class

ExecAction describes a "run in container" action.

Value Params

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

Companion

object

Companion: class

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
lun: Optional: FC target lun number
readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs: Optional: FC target worldwide names (WWNs)
wwids: Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

Companion

object

Companion: class

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

Value Params

driver: Driver is the name of the driver to use for this volume.
fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
options: Optional: Extra command options if any.
readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Companion

object

Companion: class

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Value Params

driver: Driver is the name of the driver to use for this volume.
fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
options: Optional: Extra command options if any.
readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Companion

object

Companion: class

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Value Params

datasetName: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUID: UUID of the dataset. This is unique identifier of a Flocker dataset

Companion

object

Companion: class

Represents a Persistent Disk resource in Google Compute Engine.

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

Value Params

fsType: Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partition: The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
pdName: Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Companion

object

Companion: class

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Value Params

directory: Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repository: Repository URL
revision: Commit hash for the specified revision.

Companion

object

Companion: class

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Value Params

endpoints: EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
endpointsNamespace: EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path: Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnly: ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

Companion

object

Companion: class

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Value Params

endpoints: EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path: Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnly: ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

Companion

object

Companion: class

HTTPGetAction describes an action based on HTTP Get requests.

Value Params

host: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
httpHeaders: Custom headers to set in the request. HTTP allows repeated headers.
path: Path to access on the HTTP server.
scheme: Scheme to use for connecting to the host. Defaults to HTTP.

Companion

object

Companion: class

HTTPHeader describes a custom header to be used in HTTP probes

Value Params

name: The header field name
value: The header field value

Companion

object

Companion: class

Handler defines a specific action that should be taken

Companion: object

Companion: class

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Value Params

hostnames: Hostnames for the above IP address.
ip: IP address of the host file entry.

Companion

object

Companion: class

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Value Params

path: Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type: Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

Companion

object

Companion: class

ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Value Params

chapAuthDiscovery: whether support iSCSI Discovery CHAP authentication
chapAuthSession: whether support iSCSI Session CHAP authentication
fsType: Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn: Target iSCSI Qualified Name.
iscsiInterface: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun: iSCSI Target Lun number.
portals: iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnly: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
targetPortal: iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

Companion

object

Companion: class

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Value Params

chapAuthDiscovery: whether support iSCSI Discovery CHAP authentication
chapAuthSession: whether support iSCSI Session CHAP authentication
fsType: Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn: Target iSCSI Qualified Name.
iscsiInterface: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun: iSCSI Target Lun number.
portals: iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnly: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
targetPortal: iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

Companion

object

Companion: class

Maps a string key to a path within a volume.

Value Params

key: The key to project.
mode: Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path: The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

Companion

object

Companion: class

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

Companion: object

Companion: class

LimitRange sets resource usage limits for each kind of resource in a Namespace.

Companion: object

Companion: class

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

Value Params

default: Default resource requirement limit value by resource name if resource limit is omitted.
defaultRequest: DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
max: Max usage constraints on this kind by resource name.
maxLimitRequestRatio: MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
min: Min usage constraints on this kind by resource name.
type: Type of resource that this limit applies to.

Companion

object

Companion: class

LimitRangeSpec defines a min/max usage limit for resources that match on kind.

Value Params

limits: Limits is the list of LimitRangeItem objects that are enforced.

Companion

object

Companion: class

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

Value Params

hostname: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
ports: Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

Companion

object

Companion: class

LoadBalancerStatus represents the status of a load-balancer.

Value Params

ingress: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

Companion

object

Companion: class

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Value Params

name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Companion

object

Companion: class

Local represents directly-attached storage with node affinity (Beta feature)

Value Params

fsType: Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified.
path: The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).

Companion

object

Companion: class

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Value Params

path: Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnly: ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server: Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Companion

object

Companion: class

Namespace provides a scope for Names. Use of multiple namespaces is optional.

Companion: object

Companion: class

NamespaceCondition contains details about state of namespace.

Value Params

status: Status of the condition, one of True, False, Unknown.
type: Type of namespace controller condition.

Companion

object

Companion: class

NamespaceSpec describes the attributes on a Namespace.

Value Params

finalizers: Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

Companion

object

Companion: class

NamespaceStatus is information about the current status of a Namespace.

Value Params

conditions: Represents the latest available observations of a namespace's current state.
phase: Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

Companion

object

Companion: class

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Companion: object

Companion: class

NodeAddress contains information for the node's address.

Value Params

address: The node address.
type: Node address type, one of Hostname, ExternalIP or InternalIP.

Companion

object

Companion: class

Node affinity is a group of node affinity scheduling rules.

Value Params

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

Companion

object

Companion: class

NodeCondition contains condition information for a node.

Value Params

message: Human readable message indicating details about last transition.
reason: (brief) reason for the condition's last transition.
status: Status of the condition, one of True, False, Unknown.
type: Type of node condition.

Companion

object

Companion: class

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

Companion: object

Companion: class

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

Value Params

error: Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.

Companion

object

Companion: class

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Companion: object

Companion: class

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

Value Params

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

Companion

object

Companion: class

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Value Params

key: The label key that the selector applies to.
operator: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

Companion

object

Companion: class

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

Value Params

matchExpressions: A list of node selector requirements by node's labels.
matchFields: A list of node selector requirements by node's fields.

Companion

object

Companion: class

NodeSpec describes the attributes that a node is created with.

Value Params

externalID: Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
podCIDR: PodCIDR represents the pod IP range assigned to the node.
podCIDRs: podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.
providerID: ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
taints: If specified, the node's taints.
unschedulable: Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

Companion

object

Companion: class

NodeStatus is information about the current status of a node.

Value Params

addresses: List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example.
allocatable: Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity: Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
conditions: Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
images: List of container images on this node
phase: NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
volumesAttached: List of volumes that are attached to the node.
volumesInUse: List of attachable volumes in use (mounted) by the node.

Companion

object

Companion: class

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Value Params

architecture: The Architecture reported by the node
bootID: Boot ID reported by the node.
containerRuntimeVersion: ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
kernelVersion: Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
kubeProxyVersion: KubeProxy Version reported by the node.
kubeletVersion: Kubelet Version reported by the node.
machineID: MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
operatingSystem: The Operating System reported by the node
osImage: OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
systemUUID: SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid

Companion

object

Companion: class

ObjectFieldSelector selects an APIVersioned field of an object.

Value Params

apiVersion: Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath: Path of the field to select in the specified API version.

Companion

object

Companion: class

ObjectReference contains enough information to let you inspect or modify the referred object.

Value Params

apiVersion: API version of the referent.
fieldPath: If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kind: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace: Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersion: Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uid: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

Companion

object

Companion: class

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

Companion: object

Companion: class

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Companion: object

Companion: class

PersistentVolumeClaimCondition contails details about state of pvc

Value Params

message: Human-readable message indicating details about last transition.
reason: Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.

Companion

object

Companion: class

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Value Params

accessModes: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
storageClassName: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName: VolumeName is the binding reference to the PersistentVolume backing this claim.

Companion

object

Companion: class

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Value Params

accessModes: AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
capacity: Represents the actual resources of the underlying volume.
conditions: Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
phase: Phase represents the current phase of PersistentVolumeClaim.

Companion

object

Companion: class

PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

Companion: object

Companion: class

PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

Value Params

claimName: ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnly: Will force the ReadOnly setting in VolumeMounts. Default false.

Companion

object

Companion: class

PersistentVolumeSpec is the specification of a persistent volume.

Value Params

accessModes: AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
capacity: A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
mountOptions: A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
persistentVolumeReclaimPolicy: What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
storageClassName: Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
volumeMode: volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.

Companion

object

Companion: class

PersistentVolumeStatus is the current status of a persistent volume.

Value Params

message: A human-readable message indicating details about why the volume is in this state.
phase: Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
reason: Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

Companion

object

Companion: class

Represents a Photon Controller persistent disk resource.

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
pdID: ID that identifies Photon Controller persistent disk

Companion

object

Companion: class

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

Companion: object

Companion: class

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

Value Params

preferredDuringSchedulingIgnoredDuringExecution: The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution: If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

Companion

object

Companion: class

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

Value Params

namespaces: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
topologyKey: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

Companion

object

Companion: class

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

Value Params

preferredDuringSchedulingIgnoredDuringExecution: The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

Companion

object

Companion: class

PodCondition contains details for the current condition of this pod.

Value Params

message: Human-readable message indicating details about last transition.
reason: Unique, one-word, CamelCase reason for the condition's last transition.
status: Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
type: Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

Companion

object

Companion: class

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

Value Params

nameservers: A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
options: A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
searches: A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

Companion

object

Companion: class

PodDNSConfigOption defines DNS resolver options of a pod.

Value Params

name: Required.

Companion

object

Companion: class

IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.

Value Params

ip: ip is an IP address (IPv4 or IPv6) assigned to the pod

Companion

object

Companion: class

PodReadinessGate contains the reference to a pod condition

Value Params

conditionType: ConditionType refers to a condition in the pod's condition list with matching type.

Companion

object

Companion: class

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

Value Params

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.

fsGroupChangePolicy

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.

runAsGroup

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

runAsNonRoot

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

runAsUser

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

supplementalGroups

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

sysctls

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

Companion

object

Companion: class

case class PodSpec(activeDeadlineSeconds: Optional[Long], affinity: Optional[Affinity], automountServiceAccountToken: Optional[Boolean], containers: Optional[Vector[Container]], dnsConfig: Optional[PodDNSConfig], dnsPolicy: Optional[String], enableServiceLinks: Optional[Boolean], ephemeralContainers: Optional[Vector[EphemeralContainer]], hostAliases: Optional[Vector[HostAlias]], hostIPC: Optional[Boolean], hostNetwork: Optional[Boolean], hostPID: Optional[Boolean], hostname: Optional[String], imagePullSecrets: Optional[Vector[LocalObjectReference]], initContainers: Optional[Vector[Container]], nodeName: Optional[String], nodeSelector: Optional[Map[String, String]], overhead: Optional[Map[String, Quantity]], preemptionPolicy: Optional[String], priority: Optional[Int], priorityClassName: Optional[String], readinessGates: Optional[Vector[PodReadinessGate]], restartPolicy: Optional[String], runtimeClassName: Optional[String], schedulerName: Optional[String], securityContext: Optional[PodSecurityContext], serviceAccount: Optional[String], serviceAccountName: Optional[String], setHostnameAsFQDN: Optional[Boolean], shareProcessNamespace: Optional[Boolean], subdomain: Optional[String], terminationGracePeriodSeconds: Optional[Long], tolerations: Optional[Vector[Toleration]], topologySpreadConstraints: Optional[Vector[TopologySpreadConstraint]], volumes: Optional[Vector[Volume]])

PodSpec is a description of a pod.

Value Params

activeDeadlineSeconds: Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
automountServiceAccountToken: AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
containers: List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
dnsPolicy: Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
enableServiceLinks: EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
ephemeralContainers: List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
hostAliases: HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
hostIPC: Use the host's ipc namespace. Optional: Default to false.
hostNetwork: Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
hostPID: Use the host's pid namespace. Optional: Default to false.
hostname: Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
imagePullSecrets: ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
initContainers: List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
nodeName: NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
nodeSelector: NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
overhead: Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
preemptionPolicy: PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
priority: The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
priorityClassName: If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
readinessGates: If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
restartPolicy: Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
runtimeClassName: RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.
schedulerName: If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
serviceAccount: DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
serviceAccountName: ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
setHostnameAsFQDN: If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
shareProcessNamespace: Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
subdomain: If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
terminationGracePeriodSeconds: Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
tolerations: If specified, the pod's tolerations.
topologySpreadConstraints: TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
volumes: List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

Companion

object

Companion: class

PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.

Value Params

conditions: Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
containerStatuses: The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
ephemeralContainerStatuses: Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.
hostIP: IP address of the host to which the pod is assigned. Empty if not yet scheduled.
initContainerStatuses: The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
message: A human readable message indicating details about why the pod is in this condition.
nominatedNodeName: nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
phase: The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
podIP: IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
podIPs: podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.
qosClass: The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md
reason: A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'

Companion

object

Companion: class

PodTemplate describes a template for creating copies of a predefined pod.

Companion: object

Companion: class

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

Companion: object

Companion: class

Value Params

error

Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names

cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

port

Port is the port number of the service port of which status is recorded here

protocol

Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

Companion

object

Companion: class

PortworxVolumeSource represents a Portworx volume resource.

Value Params

fsType: FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeID: VolumeID uniquely identifies a Portworx volume

Companion

object

Companion: class

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

Value Params

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

Companion

object

Companion: class

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Value Params

failureThreshold: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
initialDelaySeconds: Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSeconds: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
timeoutSeconds: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Companion

object

Companion: class

Represents a projected volume source

Value Params

defaultMode: Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
sources: list of volume projections

Companion

object

Companion: class

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Value Params

group: Group to map volume access to Default is no group
readOnly: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registry: Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
tenant: Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
user: User to map volume access to Defaults to serivceaccount user
volume: Volume is a string that references an already created Quobyte volume by name.

Companion

object

Companion: class

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Value Params

fsType: Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image: The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
keyring: Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitors: A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool: The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
readOnly: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user: The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Companion

object

Companion: class

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Value Params

fsType: Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image: The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
keyring: Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitors: A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool: The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
readOnly: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user: The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Companion

object

Companion: class

ReplicationController represents the configuration of a replication controller.

Companion: object

Companion: class

ReplicationControllerCondition describes the state of a replication controller at a certain point.

Value Params

message: A human readable message indicating details about the transition.
reason: The reason for the condition's last transition.
status: Status of the condition, one of True, False, Unknown.
type: Type of replication controller condition.

Companion

object

Companion: class

ReplicationControllerSpec is the specification of a replication controller.

Value Params

minReadySeconds: Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas: Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
selector: Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Companion

object

Companion: class

ReplicationControllerStatus represents the current status of a replication controller.

Value Params

availableReplicas: The number of available replicas (ready for at least minReadySeconds) for this replication controller.
conditions: Represents the latest available observations of a replication controller's current state.
fullyLabeledReplicas: The number of pods that have labels matching the labels of the pod template of the replication controller.
observedGeneration: ObservedGeneration reflects the generation of the most recently observed replication controller.
readyReplicas: The number of ready replicas for this replication controller.
replicas: Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

Companion

object

Companion: class

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Value Params

containerName: Container name: required for volumes, optional for env vars
resource: Required: resource to select

Companion

object

Companion: class

ResourceQuota sets aggregate quota restrictions enforced per namespace

Companion: object

Companion: class

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Value Params

hard: hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
scopes: A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

Companion

object

Companion: class

ResourceQuotaStatus defines the enforced hard limits and observed use.

Value Params

hard: Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
used: Used is the current observed total usage of the resource in the namespace.

Companion

object

Companion: class

ResourceRequirements describes the compute resource requirements.

Value Params

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

Companion

object

Companion: class

SELinuxOptions are the labels to be applied to the container

Value Params

level: Level is SELinux level label that applies to the container.
role: Role is a SELinux role label that applies to the container.
type: Type is a SELinux type label that applies to the container.
user: User is a SELinux user label that applies to the container.

Companion

object

Companion: class

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
gateway: The host address of the ScaleIO API Gateway.
protectionDomain: The name of the ScaleIO Protection Domain for the configured storage.
readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
sslEnabled: Flag to enable/disable SSL communication with Gateway, default false
storageMode: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePool: The ScaleIO Storage Pool associated with the protection domain.
system: The name of the storage system as configured in ScaleIO.
volumeName: The name of a volume already created in the ScaleIO system that is associated with this volume source.

Companion

object

Companion: class

ScaleIOVolumeSource represents a persistent ScaleIO volume

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
gateway: The host address of the ScaleIO API Gateway.
protectionDomain: The name of the ScaleIO Protection Domain for the configured storage.
readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
sslEnabled: Flag to enable/disable SSL communication with Gateway, default false
storageMode: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePool: The ScaleIO Storage Pool associated with the protection domain.
system: The name of the storage system as configured in ScaleIO.
volumeName: The name of a volume already created in the ScaleIO system that is associated with this volume source.

Companion

object

Companion: class

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

Value Params

matchExpressions: A list of scope selector requirements by scope of the resources.

Companion

object

Companion: class

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

Value Params

operator: Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
scopeName: The name of the scope that the selector applies to.
values: An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Companion

object

Companion: class

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Value Params

localhostProfile: localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
type: type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

Companion

object

Companion: class

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Value Params

data: Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
immutable: Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate.
stringData: stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
type: Used to facilitate programmatic handling of secret data.

Companion

object

Companion: class

SecretEnvSource selects a Secret to populate the environment variables with.

The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Value Params

name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional: Specify whether the Secret must be defined

Companion

object

Companion: class

SecretKeySelector selects a key of a Secret.

Value Params

key: The key of the secret to select from. Must be a valid secret key.
name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional: Specify whether the Secret or its key must be defined

Companion

object

Companion: class

Adapts a secret into a projected volume.

The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.

Value Params

items: If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional: Specify whether the Secret or its key must be defined

Companion

object

Companion: class

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

Value Params

name: Name is unique within a namespace to reference a secret resource.
namespace: Namespace defines the space within which the secret name must be unique.

Companion

object

Companion: class

Adapts a Secret into a volume.

The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

Value Params

defaultMode: Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items: If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
optional: Specify whether the Secret or its keys must be defined
secretName: Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Companion

object

Companion: class

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Value Params

allowPrivilegeEscalation: AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
privileged: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
procMount: procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.
readOnlyRootFilesystem: Whether this container has a read-only root filesystem. Default is false.
runAsGroup: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot: Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

Companion

object

Companion: class

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Companion: object

Companion: class

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

Value Params

automountServiceAccountToken: AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
imagePullSecrets: ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
secrets: Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret

Companion

object

Companion: class

ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

Value Params

audience: Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds: ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path: Path is the path relative to the mount point of the file to project the token into.

Companion

object

Companion: class

ServicePort contains information on service's port.

Value Params

appProtocol: The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
name: The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
nodePort: The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
port: The port that will be exposed by this service.
protocol: The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

Companion

object

Companion: class

case class ServiceSpec(allocateLoadBalancerNodePorts: Optional[Boolean], clusterIP: Optional[String], clusterIPs: Optional[Vector[String]], externalIPs: Optional[Vector[String]], externalName: Optional[String], externalTrafficPolicy: Optional[String], healthCheckNodePort: Optional[Int], ipFamilies: Optional[Vector[String]], ipFamilyPolicy: Optional[String], loadBalancerIP: Optional[String], loadBalancerSourceRanges: Optional[Vector[String]], ports: Optional[Vector[ServicePort]], publishNotReadyAddresses: Optional[Boolean], selector: Optional[Map[String, String]], sessionAffinity: Optional[String], sessionAffinityConfig: Optional[SessionAffinityConfig], topologyKeys: Optional[Vector[String]], `type`: Optional[String])

ServiceSpec describes the attributes that a user creates on a service.

Value Params

allocateLoadBalancerNodePorts: allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature.
clusterIP: clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
clusterIPs: ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
externalIPs: externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.
externalName: externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be
externalTrafficPolicy: externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
healthCheckNodePort: healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type).
ipFamilies: IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
ipFamilyPolicy: IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName.
loadBalancerIP: Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
loadBalancerSourceRanges: If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
ports: The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
publishNotReadyAddresses: publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior.
selector: Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/
sessionAffinity: Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
topologyKeys: topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature.
type: type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

Companion

object

Companion: class

ServiceStatus represents the current status of a service.

Value Params

conditions: Current service state

Companion

object

Companion: class

SessionAffinityConfig represents the configurations of session affinity.

Companion: object

Companion: class

Represents a StorageOS persistent volume resource.

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeName: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace: VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

Companion

object

Companion: class

Represents a StorageOS persistent volume resource.

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeName: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace: VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

Companion

object

Companion: class

Sysctl defines a kernel parameter to be set

Value Params

name: Name of a property to set
value: Value of a property to set

Companion

object

Companion: class

TCPSocketAction describes an action based on opening a socket

Value Params

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

Companion

object

Companion: class

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

Value Params

effect: Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
key: Required. The taint key to be applied to a node.
value: The taint value corresponding to the taint key.

Companion

object

Companion: class

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

Value Params

effect: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
value: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

Companion

object

Companion: class

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

Value Params

key: The label key that the selector applies to.
values: An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

Companion

object

Companion: class

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

Value Params

matchLabelExpressions: A list of topology selector requirements by labels.

Companion

object

Companion: class

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Value Params

maxSkew: MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.
topologyKey: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
whenUnsatisfiable: WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

Companion

object

Companion: class

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

Value Params

apiGroup: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind: Kind is the type of resource being referenced
name: Name is the name of resource being referenced

Companion

object

Companion: class

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Value Params

name: Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Companion

object

Companion: class

volumeDevice describes a mapping of a raw block device within a container.

Value Params

devicePath: devicePath is the path inside of the container that the device will be mapped to.
name: name must match the name of a persistentVolumeClaim in the pod

Companion

object

Companion: class

VolumeMount describes a mounting of a Volume within a container.

Value Params

mountPath: Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation: mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
name: This must match the Name of a Volume.
readOnly: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
subPath: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
subPathExpr: Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $$(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

Companion

object

Companion: class

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

Companion: object

Companion: class

Projection that may be projected along with other supported volume types

Companion: object

Companion: class

Represents a vSphere volume resource.

Value Params

fsType: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
storagePolicyID: Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyName: Storage Policy Based Management (SPBM) profile name.
volumePath: Path that identifies vSphere volume vmdk

Companion

object

Companion: class

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Value Params

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

Companion

object

Companion: class

WindowsSecurityContextOptions contain Windows-specific options and credentials.

Value Params

gmsaCredentialSpec: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
gmsaCredentialSpecName: GMSACredentialSpecName is the name of the GMSA credential spec to use.
runAsUserName: The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

Companion

object

Companion: class

com.coralogix.zio.k8s.model.core.v1

Type members

Classlikes