Module core/v1

@pulumi/kubernetes > core > v1

Index

types/input.ts types/output.ts

function isBinding

isBinding(o: any): boolean

function isComponentStatus

isComponentStatus(o: any): boolean

function isComponentStatusList

isComponentStatusList(o: any): boolean

function isConfigMap

isConfigMap(o: any): boolean

function isConfigMapList

isConfigMapList(o: any): boolean

function isEndpoints

isEndpoints(o: any): boolean

function isEndpointsList

isEndpointsList(o: any): boolean

function isEvent

isEvent(o: any): boolean

function isEventList

isEventList(o: any): boolean

function isLimitRange

isLimitRange(o: any): boolean

function isLimitRangeList

isLimitRangeList(o: any): boolean

function isNamespace

isNamespace(o: any): boolean

function isNamespaceList

isNamespaceList(o: any): boolean

function isNode

isNode(o: any): boolean

function isNodeList

isNodeList(o: any): boolean

function isObjectFieldSelector

isObjectFieldSelector(o: any): boolean

function isObjectReference

isObjectReference(o: any): boolean

function isPersistentVolume

isPersistentVolume(o: any): boolean

function isPersistentVolumeClaim

isPersistentVolumeClaim(o: any): boolean

function isPersistentVolumeClaimList

isPersistentVolumeClaimList(o: any): boolean

function isPersistentVolumeList

isPersistentVolumeList(o: any): boolean

function isPod

isPod(o: any): boolean

function isPodList

isPodList(o: any): boolean

function isPodTemplate

isPodTemplate(o: any): boolean

function isPodTemplateList

isPodTemplateList(o: any): boolean

function isReplicationController

isReplicationController(o: any): boolean

function isReplicationControllerList

isReplicationControllerList(o: any): boolean

function isResourceQuota

isResourceQuota(o: any): boolean

function isResourceQuotaList

isResourceQuotaList(o: any): boolean

function isSecret

isSecret(o: any): boolean

function isSecretList

isSecretList(o: any): boolean

function isService

isService(o: any): boolean

function isServiceAccount

isServiceAccount(o: any): boolean

function isServiceAccountList

isServiceAccountList(o: any): boolean

function isServiceList

isServiceList(o: any): boolean

interface AWSElasticBlockStoreVolumeSource

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.

property fsType

fsType: string;

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

property partition

partition: number;

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).

property readOnly

readOnly: boolean;

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

property volumeID

volumeID: string;

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

interface Affinity

Affinity is a group of affinity scheduling rules.

property nodeAffinity

nodeAffinity: NodeAffinity;

Describes node affinity scheduling rules for the pod.

property podAffinity

podAffinity: PodAffinity;

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

property podAntiAffinity

podAntiAffinity: PodAntiAffinity;

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

interface AttachedVolume

AttachedVolume describes a volume attached to a node

property devicePath

devicePath: string;

DevicePath represents the device path where the volume should be available

property name

name: string;

Name of the attached volume

interface AzureDiskVolumeSource

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

property cachingMode

cachingMode: string;

Host Caching mode: None, Read Only, Read Write.

property diskName

diskName: string;

The Name of the data disk in the blob storage

property diskURI

diskURI: string;

The URI the data disk in the blob storage

property fsType

fsType: string;

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.

property kind

kind: string;

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

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

interface AzureFilePersistentVolumeSource

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

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretName

secretName: string;

the name of secret that contains Azure Storage Account Name and Key

property secretNamespace

secretNamespace: string;

the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod

property shareName

shareName: string;

Share Name

interface AzureFileVolumeSource

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

property readOnly

readOnly: boolean;

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretName

secretName: string;

the name of secret that contains Azure Storage Account Name and Key

property shareName

shareName: string;

Share Name

interface Binding

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.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

property target

target: ObjectReference;

The target object that you want to bind to the standard object.

interface CSIPersistentVolumeSource

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

property controllerPublishSecretRef

controllerPublishSecretRef: SecretReference;

ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

property driver

driver: string;

Driver is the name of the driver to use for this volume. Required.

property fsType

fsType: string;

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”.

property nodePublishSecretRef

nodePublishSecretRef: SecretReference;

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

property nodeStageSecretRef

nodeStageSecretRef: SecretReference;

NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

property readOnly

readOnly: boolean;

Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).

property volumeAttributes

volumeAttributes: { ... };

Attributes of the volume to publish.

property volumeHandle

volumeHandle: string;

VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

interface Capabilities

Adds and removes POSIX capabilities from running containers.

property add

add: string[];

Added capabilities

property drop

drop: string[];

Removed capabilities

interface CephFSPersistentVolumeSource

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

property monitors

monitors: string[];

Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property path

path: string;

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property secretFile

secretFile: string;

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property secretRef

secretRef: SecretReference;

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property user

user: string;

Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

interface CephFSVolumeSource

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

property monitors

monitors: string[];

Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property path

path: string;

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property secretFile

secretFile: string;

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property secretRef

secretRef: LocalObjectReference;

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

property user

user: string;

Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

interface CinderPersistentVolumeSource

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.

property fsType

fsType: string;

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://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

property secretRef

secretRef: SecretReference;

Optional: points to a secret object containing parameters used to connect to OpenStack.

property volumeID

volumeID: string;

volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

interface CinderVolumeSource

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.

property fsType

fsType: string;

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://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

property secretRef

secretRef: LocalObjectReference;

Optional: points to a secret object containing parameters used to connect to OpenStack.

property volumeID

volumeID: string;

volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

interface ClientIPConfig

ClientIPConfig represents the configurations of Client IP based session affinity.

property timeoutSeconds

timeoutSeconds: number;

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).

interface ComponentCondition

Information about the condition of a component.

property error

error: string;

Condition error code for a component. For example, a health check error code.

property message

message: string;

Message about the condition for a component. For example, information about a health check.

property status

status: string;

Status of the condition for a component. Valid values for “Healthy”: “True”, “False”, or “Unknown”.

property type

type: string;

Type of condition for a component. Valid value: “Healthy”

interface ComponentStatus

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property conditions

conditions: ComponentCondition[];

List of component conditions observed

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

interface ComponentStatusList

Status of all the conditions for the component as a list of ComponentStatus objects.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: ComponentStatus[];

List of ComponentStatus objects.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

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

interface ConfigMap

ConfigMap holds configuration data for pods to consume.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property binaryData

binaryData: object;

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.

property data

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.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

interface ConfigMapEnvSource

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.

property name

name: string;

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

property optional

optional: boolean;

Specify whether the ConfigMap must be defined

interface ConfigMapKeySelector

Selects a key from a ConfigMap.

property key

key: string;

The key to select.

property name

name: string;

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

property optional

optional: boolean;

Specify whether the ConfigMap or it’s key must be defined

interface ConfigMapList

ConfigMapList is a resource containing a list of ConfigMap objects.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: ConfigMap[];

Items is the list of ConfigMaps.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

interface ConfigMapNodeConfigSource

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

property kubeletConfigKey

kubeletConfigKey: string;

KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

property name

name: string;

Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

property namespace

namespace: string;

Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

property resourceVersion

resourceVersion: string;

ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

property uid

uid: string;

UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

interface ConfigMapProjection

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.

property items

items: KeyToPath[];

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 ‘..’.

property name

name: string;

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

property optional

optional: boolean;

Specify whether the ConfigMap or it’s keys must be defined

interface ConfigMapVolumeSource

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.

property defaultMode

defaultMode: number;

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property items

items: KeyToPath[];

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 ‘..’.

property name

name: string;

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

property optional

optional: boolean;

Specify whether the ConfigMap or it’s keys must be defined

interface Container

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

property args

args: string[];

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

property command

command: string[];

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

property env

env: EnvVar[];

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

property envFrom

envFrom: EnvFromSource[];

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.

property image

image: string;

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.

property imagePullPolicy

imagePullPolicy: string;

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

property lifecycle

lifecycle: Lifecycle;

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

property livenessProbe

livenessProbe: Probe;

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

property name

name: string;

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

property ports

ports: ContainerPort[];

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.

property readinessProbe

readinessProbe: Probe;

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

property resources

resources: ResourceRequirements;

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

property securityContext

securityContext: SecurityContext;

Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

property stdin

stdin: boolean;

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.

property stdinOnce

stdinOnce: boolean;

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

property terminationMessagePath

terminationMessagePath: string;

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.

property terminationMessagePolicy

terminationMessagePolicy: string;

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.

property tty

tty: boolean;

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

property volumeDevices

volumeDevices: VolumeDevice[];

volumeDevices is the list of block devices to be used by the container. This is a beta feature.

property volumeMounts

volumeMounts: VolumeMount[];

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

property workingDir

workingDir: string;

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.

interface ContainerImage

Describe a container image

property names

names: string[];

Names by which this image is known. e.g. [“k8s.gcr.io/hyperkube:v1.0.7”, “dockerhub.io/google_containers/hyperkube:v1.0.7”]

property sizeBytes

sizeBytes: number;

The size of the image in bytes.

interface ContainerPort

ContainerPort represents a network port in a single container.

property containerPort

containerPort: number;

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

property hostIP

hostIP: string;

What host IP to bind the external port to.

property hostPort

hostPort: number;

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.

property name

name: string;

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

property protocol

protocol: string;

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

interface ContainerState

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.

property running

running: ContainerStateRunning;

Details about a running container

property terminated

terminated: ContainerStateTerminated;

Details about a terminated container

property waiting

waiting: ContainerStateWaiting;

Details about a waiting container

interface ContainerStateRunning

ContainerStateRunning is a running state of a container.

property startedAt

startedAt: string;

Time at which the container was last (re-)started

interface ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.

property containerID

containerID: string;

Container’s ID in the format ‘docker://'

property exitCode

exitCode: number;

Exit status from the last termination of the container

property finishedAt

finishedAt: string;

Time at which the container last terminated

property message

message: string;

Message regarding the last termination of the container

property reason

reason: string;

(brief) reason from the last termination of the container

property signal

signal: number;

Signal from the last termination of the container

property startedAt

startedAt: string;

Time at which previous execution of the container started

interface ContainerStateWaiting

ContainerStateWaiting is a waiting state of a container.

property message

message: string;

Message regarding why the container is not yet running.

property reason

reason: string;

(brief) reason the container is not yet running.

interface ContainerStatus

ContainerStatus contains details for the current status of this container.

property containerID

containerID: string;

Container’s ID in the format ‘docker://'.

property image

image: string;

The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images

property imageID

imageID: string;

ImageID of the container’s image.

property lastState

lastState: ContainerState;

Details about the container’s last termination condition.

property name

name: string;

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

property ready

ready: boolean;

Specifies whether the container has passed its readiness probe.

property restartCount

restartCount: number;

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.

property state

state: ContainerState;

Details about the container’s current condition.

interface DaemonEndpoint

DaemonEndpoint contains information about a single Daemon endpoint.

property Port

Port: number;

Port number of the given endpoint.

interface DownwardAPIProjection

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

property items

items: DownwardAPIVolumeFile[];

Items is a list of DownwardAPIVolume file

interface DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

property fieldRef

fieldRef: ObjectFieldSelector;

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

property mode

mode: number;

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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.

property path

path: string;

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’

property resourceFieldRef

resourceFieldRef: ResourceFieldSelector;

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

interface DownwardAPIVolumeSource

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

property defaultMode

defaultMode: number;

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property items

items: DownwardAPIVolumeFile[];

Items is a list of downward API volume file

interface EmptyDirVolumeSource

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

property medium

medium: string;

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

property sizeLimit

sizeLimit: string;

Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

interface EndpointAddress

EndpointAddress is a tuple that describes single IP address.

property hostname

hostname: string;

The Hostname of this endpoint

property ip

ip: string;

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.

property nodeName

nodeName: string;

Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

property targetRef

targetRef: ObjectReference;

Reference to object providing the endpoint.

interface EndpointPort

EndpointPort is a tuple that describes a single port.

property name

name: string;

The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.

property port

port: number;

The port number of the endpoint.

property protocol

protocol: string;

The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

interface EndpointSubset

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 ]

property addresses

addresses: EndpointAddress[];

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.

property notReadyAddresses

notReadyAddresses: EndpointAddress[];

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.

property ports

ports: EndpointPort[];

Port numbers available on the related IP addresses.

interface Endpoints

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}] }, ]

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

property subsets

subsets: EndpointSubset[];

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.

interface EndpointsList

EndpointsList is a list of endpoints.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: Endpoints[];

List of endpoints.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

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

interface EnvFromSource

EnvFromSource represents the source of a set of ConfigMaps

property configMapRef

configMapRef: ConfigMapEnvSource;

The ConfigMap to select from

property prefix

prefix: string;

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

property secretRef

secretRef: SecretEnvSource;

The Secret to select from

interface EnvVar

EnvVar represents an environment variable present in a Container.

property name

name: string;

Name of the environment variable. Must be a C_IDENTIFIER.

property value

value: string;

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 (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

property valueFrom

valueFrom: EnvVarSource;

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

interface EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

property configMapKeyRef

configMapKeyRef: ConfigMapKeySelector;

Selects a key of a ConfigMap.

property fieldRef

fieldRef: ObjectFieldSelector;

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.

property resourceFieldRef

resourceFieldRef: ResourceFieldSelector;

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

property secretKeyRef

secretKeyRef: SecretKeySelector;

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

interface Event

Event is a report of an event somewhere in the cluster.

property action

action: string;

What action was taken/failed regarding to the Regarding object.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property count

count: number;

The number of times this event has occurred.

property eventTime

eventTime: string;

Time when this Event was first observed.

property firstTimestamp

firstTimestamp: string;

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

property involvedObject

involvedObject: ObjectReference;

The object that this event is about.

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property lastTimestamp

lastTimestamp: string;

The time at which the most recent occurrence of this event was recorded.

property message

message: string;

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

property metadata

metadata: ObjectMeta;

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

property reason

reason: string;

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

property related

related: ObjectReference;

Optional secondary object for more complex actions.

property reportingComponent

reportingComponent: string;

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.

property reportingInstance

reportingInstance: string;

ID of the controller instance, e.g. kubelet-xyzf.

property series

series: EventSeries;

Data about the Event series this event represents or nil if it’s a singleton Event.

property source

source: EventSource;

The component reporting this event. Should be a short machine understandable string.

property type

type: string;

Type of this event (Normal, Warning), new types could be added in the future

interface EventList

EventList is a list of events.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: Event[];

List of events

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

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

interface EventSeries

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

property count

count: number;

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

property lastObservedTime

lastObservedTime: string;

Time of the last occurrence observed

property state

state: string;

State of this Series: Ongoing or Finished

interface EventSource

EventSource contains information for an event.

property component

component: string;

Component from which the event is generated.

property host

host: string;

Node name on which the event is generated.

interface ExecAction

ExecAction describes a “run in container” action.

property command

command: string[];

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

interface FCVolumeSource

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.

property fsType

fsType: string;

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.

property lun

lun: number;

Optional: FC target lun number

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property targetWWNs

targetWWNs: string[];

Optional: FC target worldwide names (WWNs)

property wwids

wwids: string[];

Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

interface FlexPersistentVolumeSource

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

property driver

driver: string;

Driver is the name of the driver to use for this volume.

property fsType

fsType: string;

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.

property options

options: { ... };

Optional: Extra command options if any.

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

secretRef: SecretReference;

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

interface FlexVolumeSource

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

property driver

driver: string;

Driver is the name of the driver to use for this volume.

property fsType

fsType: string;

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.

property options

options: { ... };

Optional: Extra command options if any.

property readOnly

readOnly: boolean;

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

secretRef: LocalObjectReference;

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

interface FlockerVolumeSource

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.

property datasetName

datasetName: string;

Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated

property datasetUUID

datasetUUID: string;

UUID of the dataset. This is unique identifier of a Flocker dataset

interface GCEPersistentDiskVolumeSource

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.

property fsType

fsType: string;

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

property partition

partition: number;

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

property pdName

pdName: string;

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

property readOnly

readOnly: boolean;

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

interface GitRepoVolumeSource

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.

property directory

directory: string;

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.

property repository

repository: string;

Repository URL

property revision

revision: string;

Commit hash for the specified revision.

interface GlusterfsPersistentVolumeSource

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

property endpoints

endpoints: string;

EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

property endpointsNamespace

endpointsNamespace: string;

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://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

property path

path: string;

Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

property readOnly

readOnly: boolean;

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

interface GlusterfsVolumeSource

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

property endpoints

endpoints: string;

EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

property path

path: string;

Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

property readOnly

readOnly: boolean;

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

interface HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

property host

host: string;

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

property httpHeaders

httpHeaders: HTTPHeader[];

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

property path

path: string;

Path to access on the HTTP server.

property port

port: number | string;

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

  1. Name must be an IANA_SVC_NAME.

property scheme

scheme: string;

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

interface HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

property name

name: string;

The header field name

property value

value: string;

The header field value

interface Handler

Handler defines a specific action that should be taken

property exec

exec: ExecAction;

One and only one of the following should be specified. Exec specifies the action to take.

property httpGet

httpGet: HTTPGetAction;

HTTPGet specifies the http request to perform.

property tcpSocket

tcpSocket: TCPSocketAction;

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

interface HostAlias

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

property hostnames

hostnames: string[];

Hostnames for the above IP address.

property ip

ip: string;

IP address of the host file entry.

interface HostPathVolumeSource

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

property path

path: string;

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

property type

type: string;

Type for HostPath Volume Defaults to “” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

interface ISCSIPersistentVolumeSource

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

property chapAuthDiscovery

chapAuthDiscovery: boolean;

whether support iSCSI Discovery CHAP authentication

property chapAuthSession

chapAuthSession: boolean;

whether support iSCSI Session CHAP authentication

property fsType

fsType: string;

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

property initiatorName

initiatorName: string;

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.

property iqn

iqn: string;

Target iSCSI Qualified Name.

property iscsiInterface

iscsiInterface: string;

iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).

property lun

lun: number;

iSCSI Target Lun number.

property portals

portals: string[];

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).

property readOnly

readOnly: boolean;

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

property secretRef

secretRef: SecretReference;

CHAP Secret for iSCSI target and initiator authentication

property targetPortal

targetPortal: string;

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).

interface ISCSIVolumeSource

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

property chapAuthDiscovery

chapAuthDiscovery: boolean;

whether support iSCSI Discovery CHAP authentication

property chapAuthSession

chapAuthSession: boolean;

whether support iSCSI Session CHAP authentication

property fsType

fsType: string;

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

property initiatorName

initiatorName: string;

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.

property iqn

iqn: string;

Target iSCSI Qualified Name.

property iscsiInterface

iscsiInterface: string;

iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp).

property lun

lun: number;

iSCSI Target Lun number.

property portals

portals: string[];

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).

property readOnly

readOnly: boolean;

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

property secretRef

secretRef: LocalObjectReference;

CHAP Secret for iSCSI target and initiator authentication

property targetPortal

targetPortal: string;

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).

interface KeyToPath

Maps a string key to a path within a volume.

property key

key: string;

The key to project.

property mode

mode: number;

Optional: mode bits to use on this file, must be a value between 0 and 0777. 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.

property path

path: string;

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 ‘..’.

interface Lifecycle

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.

property postStart

postStart: Handler;

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

property preStop

preStop: Handler;

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

interface LimitRange

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

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

property spec

spec: LimitRangeSpec;

Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface LimitRangeItem

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

property default

default: object;

Default resource requirement limit value by resource name if resource limit is omitted.

property defaultRequest

defaultRequest: object;

DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

property max

max: object;

Max usage constraints on this kind by resource name.

property maxLimitRequestRatio

maxLimitRequestRatio: object;

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.

property min

min: object;

Min usage constraints on this kind by resource name.

property type

type: string;

Type of resource that this limit applies to.

interface LimitRangeList

LimitRangeList is a list of LimitRange items.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: LimitRange[];

Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

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

interface LimitRangeSpec

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

property limits

limits: LimitRangeItem[];

Limits is the list of LimitRangeItem objects that are enforced.

interface LoadBalancerIngress

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

property hostname

hostname: string;

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

property ip

ip: string;

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

interface LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.

property ingress

ingress: LoadBalancerIngress[];

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

interface LocalObjectReference

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

property name

name: string;

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

interface LocalVolumeSource

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

property fsType

fsType: string;

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.

property path

path: string;

The full path to the volume on the node. It can be either a directory or block device (disk, partition, …).

interface NFSVolumeSource

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

property path

path: string;

Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

property readOnly

readOnly: boolean;

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

property server

server: string;

Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

interface Namespace

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

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

property spec

spec: NamespaceSpec;

Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

status: NamespaceStatus;

Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface NamespaceList

NamespaceList is a list of Namespaces.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: Namespace[];

Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

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

interface NamespaceSpec

NamespaceSpec describes the attributes on a Namespace.

property finalizers

finalizers: string[];

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/

interface NamespaceStatus

NamespaceStatus is information about the current status of a Namespace.

property phase

phase: string;

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

interface Node

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

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

property spec

spec: NodeSpec;

Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

status: NodeStatus;

Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface NodeAddress

NodeAddress contains information for the node’s address.

property address

address: string;

The node address.

property type

type: string;

Node address type, one of Hostname, ExternalIP or InternalIP.

interface NodeAffinity

Node affinity is a group of node affinity scheduling rules.

property preferredDuringSchedulingIgnoredDuringExecution

preferredDuringSchedulingIgnoredDuringExecution: PreferredSchedulingTerm[];

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.

property requiredDuringSchedulingIgnoredDuringExecution

requiredDuringSchedulingIgnoredDuringExecution: NodeSelector;

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

interface NodeCondition

NodeCondition contains condition information for a node.

property lastHeartbeatTime

lastHeartbeatTime: string;

Last time we got an update on a given condition.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transit from one status to another.

property message

message: string;

Human readable message indicating details about last transition.

property reason

reason: string;

(brief) reason for the condition’s last transition.

property status

status: string;

Status of the condition, one of True, False, Unknown.

property type

type: string;

Type of node condition.

interface NodeConfigSource

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

property configMap

configMap: ConfigMapNodeConfigSource;

ConfigMap is a reference to a Node’s ConfigMap

interface NodeConfigStatus

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

property active

active: NodeConfigSource;

Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error.

property assigned

assigned: NodeConfigSource;

Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned.

property error

error: string;

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.

property lastKnownGood

lastKnownGood: NodeConfigSource;

LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node’s method of determining config stability and correctness, as this may change or become configurable in the future.

interface NodeDaemonEndpoints

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

property kubeletEndpoint

kubeletEndpoint: DaemonEndpoint;

Endpoint on which Kubelet is listening.

interface NodeList

NodeList is the whole list of all Nodes which have been registered with master.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: Node[];

List of nodes

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

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

interface NodeSelector

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.

property nodeSelectorTerms

nodeSelectorTerms: NodeSelectorTerm[];

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

interface NodeSelectorRequirement

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

property key

key: string;

The label key that the selector applies to.

property operator

operator: string;

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

property values

values: string[];

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

interface NodeSelectorTerm

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.

property matchExpressions

matchExpressions: NodeSelectorRequirement[];

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

property matchFields

matchFields: NodeSelectorRequirement[];

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

interface NodeSpec

NodeSpec describes the attributes that a node is created with.

property configSource

configSource: NodeConfigSource;

If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field

property externalID

externalID: string;

Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966

property podCIDR

podCIDR: string;

PodCIDR represents the pod IP range assigned to the node.

property providerID

providerID: string;

ID of the node assigned by the cloud provider in the format:

://

property taints

```typescript taints: Taint[]; ``` If specified, the node's taints.

property unschedulable

```typescript unschedulable: boolean; ``` Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

interface NodeStatus

NodeStatus is information about the current status of a node.

property addresses

```typescript addresses: NodeAddress[]; ``` List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses

property allocatable

```typescript allocatable: object; ``` Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

property capacity

```typescript capacity: object; ``` Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

property conditions

```typescript conditions: NodeCondition[]; ``` Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition

property config

```typescript config: NodeConfigStatus; ``` Status of the config assigned to the node via the dynamic Kubelet config feature.

property daemonEndpoints

```typescript daemonEndpoints: NodeDaemonEndpoints; ``` Endpoints of daemons running on the Node.

property images

```typescript images: ContainerImage[]; ``` List of container images on this node

property nodeInfo

```typescript nodeInfo: NodeSystemInfo; ``` Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info

property phase

```typescript phase: string; ``` 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.

property volumesAttached

```typescript volumesAttached: AttachedVolume[]; ``` List of volumes that are attached to the node.

property volumesInUse

```typescript volumesInUse: string[]; ``` List of attachable volumes in use (mounted) by the node.

interface NodeSystemInfo

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

property architecture

```typescript architecture: string; ``` The Architecture reported by the node

property bootID

```typescript bootID: string; ``` Boot ID reported by the node.

property containerRuntimeVersion

```typescript containerRuntimeVersion: string; ``` ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

property kernelVersion

```typescript kernelVersion: string; ``` Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).

property kubeProxyVersion

```typescript kubeProxyVersion: string; ``` KubeProxy Version reported by the node.

property kubeletVersion

```typescript kubeletVersion: string; ``` Kubelet Version reported by the node.

property machineID

```typescript machineID: string; ``` 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

property operatingSystem

```typescript operatingSystem: string; ``` The Operating System reported by the node

property osImage

```typescript osImage: string; ``` OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

property systemUUID

```typescript systemUUID: string; ``` 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/getting-system-uuid.html

interface ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

property apiVersion

```typescript apiVersion: string; ``` Version of the schema the FieldPath is written in terms of, defaults to "v1".

property fieldPath

```typescript fieldPath: string; ``` Path of the field to select in the specified API version.

interface ObjectReference

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

property apiVersion

```typescript apiVersion: string; ``` API version of the referent.

property fieldPath

```typescript fieldPath: string; ``` 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.

property kind

```typescript kind: string; ``` Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property name

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

property namespace

```typescript namespace: string; ``` Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

property resourceVersion

```typescript resourceVersion: string; ``` Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

property uid

```typescript uid: string; ``` UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

interface PersistentVolume

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

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

```typescript spec: PersistentVolumeSpec; ``` Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes

property status

```typescript status: PersistentVolumeStatus; ``` Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes

interface PersistentVolumeClaim

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

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

```typescript spec: PersistentVolumeClaimSpec; ``` Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

property status

```typescript status: PersistentVolumeClaimStatus; ``` Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

interface PersistentVolumeClaimCondition

PersistentVolumeClaimCondition contails details about state of pvc

property lastProbeTime

```typescript lastProbeTime: string; ``` Last time we probed the condition.

property lastTransitionTime

```typescript lastTransitionTime: string; ``` Last time the condition transitioned from one status to another.

property message

```typescript message: string; ``` Human-readable message indicating details about last transition.

property reason

```typescript reason: string; ``` 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.

property status

```typescript status: string; ```

property type

```typescript type: string; ```

interface PersistentVolumeClaimList

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: PersistentVolumeClaim[]; ``` A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface PersistentVolumeClaimSpec

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

property accessModes

```typescript accessModes: string[]; ``` AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

property dataSource

```typescript dataSource: TypedLocalObjectReference; ``` This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.

property resources

```typescript resources: ResourceRequirements; ``` Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

property selector

```typescript selector: LabelSelector; ``` A label query over volumes to consider for binding.

property storageClassName

```typescript storageClassName: string; ``` Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

property volumeMode

```typescript volumeMode: string; ``` volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature.

property volumeName

```typescript volumeName: string; ``` VolumeName is the binding reference to the PersistentVolume backing this claim.

interface PersistentVolumeClaimStatus

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

property accessModes

```typescript accessModes: string[]; ``` 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

property capacity

```typescript capacity: object; ``` Represents the actual resources of the underlying volume.

property conditions

```typescript conditions: PersistentVolumeClaimCondition[]; ``` Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.

property phase

```typescript phase: string; ``` Phase represents the current phase of PersistentVolumeClaim.

interface PersistentVolumeClaimVolumeSource

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).

property claimName

```typescript claimName: string; ``` ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

property readOnly

```typescript readOnly: boolean; ``` Will force the ReadOnly setting in VolumeMounts. Default false.

interface PersistentVolumeList

PersistentVolumeList is a list of PersistentVolume items.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: PersistentVolume[]; ``` List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface PersistentVolumeSpec

PersistentVolumeSpec is the specification of a persistent volume.

property accessModes

```typescript accessModes: string[]; ``` AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

property awsElasticBlockStore

```typescript awsElasticBlockStore: AWSElasticBlockStoreVolumeSource; ``` AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

property azureDisk

```typescript azureDisk: AzureDiskVolumeSource; ``` AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

property azureFile

```typescript azureFile: AzureFilePersistentVolumeSource; ``` AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

property capacity

```typescript capacity: object; ``` A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

property cephfs

```typescript cephfs: CephFSPersistentVolumeSource; ``` CephFS represents a Ceph FS mount on the host that shares a pod's lifetime

property cinder

```typescript cinder: CinderPersistentVolumeSource; ``` Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

property claimRef

```typescript claimRef: ObjectReference; ``` ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

property csi

```typescript csi: CSIPersistentVolumeSource; ``` CSI represents storage that handled by an external CSI driver (Beta feature).

property fc

```typescript fc: FCVolumeSource; ``` FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

property flexVolume

```typescript flexVolume: FlexPersistentVolumeSource; ``` FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

property flocker

```typescript flocker: FlockerVolumeSource; ``` Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running

property gcePersistentDisk

```typescript gcePersistentDisk: GCEPersistentDiskVolumeSource; ``` GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

property glusterfs

```typescript glusterfs: GlusterfsPersistentVolumeSource; ``` Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

property hostPath

```typescript hostPath: HostPathVolumeSource; ``` HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

property iscsi

```typescript iscsi: ISCSIPersistentVolumeSource; ``` ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.

property local

```typescript local: LocalVolumeSource; ``` Local represents directly-attached storage with node affinity

property mountOptions

```typescript mountOptions: string[]; ``` 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

property nfs

```typescript nfs: NFSVolumeSource; ``` NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

property nodeAffinity

```typescript nodeAffinity: VolumeNodeAffinity; ``` NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.

property persistentVolumeReclaimPolicy

```typescript persistentVolumeReclaimPolicy: string; ``` 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

property photonPersistentDisk

```typescript photonPersistentDisk: PhotonPersistentDiskVolumeSource; ``` PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

property portworxVolume

```typescript portworxVolume: PortworxVolumeSource; ``` PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

property quobyte

```typescript quobyte: QuobyteVolumeSource; ``` Quobyte represents a Quobyte mount on the host that shares a pod's lifetime

property rbd

```typescript rbd: RBDPersistentVolumeSource; ``` RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

property scaleIO

```typescript scaleIO: ScaleIOPersistentVolumeSource; ``` ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

property storageClassName

```typescript storageClassName: string; ``` Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

property storageos

```typescript storageos: StorageOSPersistentVolumeSource; ``` StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md

property volumeMode

```typescript volumeMode: string; ``` 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. This is a beta feature.

property vsphereVolume

```typescript vsphereVolume: VsphereVirtualDiskVolumeSource; ``` VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

interface PersistentVolumeStatus

PersistentVolumeStatus is the current status of a persistent volume.

property message

```typescript message: string; ``` A human-readable message indicating details about why the volume is in this state.

property phase

```typescript phase: string; ``` 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

property reason

```typescript reason: string; ``` Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

interface PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

property fsType

```typescript fsType: string; ``` 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.

property pdID

```typescript pdID: string; ``` ID that identifies Photon Controller persistent disk

interface Pod

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

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

```typescript spec: PodSpec; ``` Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

```typescript status: PodStatus; ``` Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface PodAffinity

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

property preferredDuringSchedulingIgnoredDuringExecution

```typescript preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[]; ``` 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.

property requiredDuringSchedulingIgnoredDuringExecution

```typescript requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[]; ``` 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.

interface PodAffinityTerm

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 matches that of any node on which a pod of the set of pods is running

property labelSelector

```typescript labelSelector: LabelSelector; ``` A label query over a set of resources, in this case pods.

property namespaces

```typescript namespaces: string[]; ``` namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"

property topologyKey

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

interface PodAntiAffinity

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

property preferredDuringSchedulingIgnoredDuringExecution

```typescript preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[]; ``` 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.

property requiredDuringSchedulingIgnoredDuringExecution

```typescript requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[]; ``` 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.

interface PodCondition

PodCondition contains details for the current condition of this pod.

property lastProbeTime

```typescript lastProbeTime: string; ``` Last time we probed the condition.

property lastTransitionTime

```typescript lastTransitionTime: string; ``` Last time the condition transitioned from one status to another.

property message

```typescript message: string; ``` Human-readable message indicating details about last transition.

property reason

```typescript reason: string; ``` Unique, one-word, CamelCase reason for the condition's last transition.

property status

```typescript status: string; ``` 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

property type

```typescript type: string; ``` Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

interface PodDNSConfig

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

property nameservers

```typescript nameservers: string[]; ``` A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

property options

```typescript options: PodDNSConfigOption[]; ``` 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.

property searches

```typescript searches: string[]; ``` A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

interface PodDNSConfigOption

PodDNSConfigOption defines DNS resolver options of a pod.

property name

```typescript name: string; ``` Required.

property value

```typescript value: string; ```

interface PodList

PodList is a list of Pods.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: Pod[]; ``` List of pods. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface PodReadinessGate

PodReadinessGate contains the reference to a pod condition

property conditionType

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

interface PodSecurityContext

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.

property fsGroup

```typescript fsGroup: number; ``` 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: 1. 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.

property runAsGroup

```typescript runAsGroup: number; ``` 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.

property runAsNonRoot

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

property runAsUser

```typescript runAsUser: number; ``` 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.

property seLinuxOptions

```typescript seLinuxOptions: SELinuxOptions; ``` The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

property supplementalGroups

```typescript supplementalGroups: number[]; ``` 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.

property sysctls

```typescript sysctls: Sysctl[]; ``` Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.

interface PodSpec

PodSpec is a description of a pod.

property activeDeadlineSeconds

```typescript activeDeadlineSeconds: number; ``` 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.

property affinity

```typescript affinity: Affinity; ``` If specified, the pod's scheduling constraints

property automountServiceAccountToken

```typescript automountServiceAccountToken: boolean; ``` AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

property containers

```typescript containers: Container[]; ``` 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.

property dnsConfig

```typescript dnsConfig: PodDNSConfig; ``` Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

property dnsPolicy

```typescript dnsPolicy: string; ``` 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'.

property enableServiceLinks

```typescript enableServiceLinks: boolean; ``` EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links.

property hostAliases

```typescript hostAliases: HostAlias[]; ``` 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.

property hostIPC

```typescript hostIPC: boolean; ``` Use the host's ipc namespace. Optional: Default to false.

property hostNetwork

```typescript hostNetwork: boolean; ``` 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.

property hostPID

```typescript hostPID: boolean; ``` Use the host's pid namespace. Optional: Default to false.

property hostname

```typescript hostname: string; ``` Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

property imagePullSecrets

```typescript imagePullSecrets: LocalObjectReference[]; ``` 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

property initContainers

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

property nodeName

```typescript nodeName: string; ``` 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.

property nodeSelector

```typescript 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/

property priority

```typescript priority: number; ``` 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.

property priorityClassName

```typescript priorityClassName: string; ``` 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.

property readinessGates

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

property restartPolicy

```typescript restartPolicy: string; ``` 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

property runtimeClassName

```typescript runtimeClassName: string; ``` 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://github.com/kubernetes/community/blob/master/keps/sig-node/0014-runtime-class.md This is an alpha feature and may change in the future.

property schedulerName

```typescript schedulerName: string; ``` If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

property securityContext

```typescript securityContext: PodSecurityContext; ``` SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

property serviceAccount

```typescript serviceAccount: string; ``` DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

property serviceAccountName

```typescript serviceAccountName: string; ``` 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/

property shareProcessNamespace

```typescript shareProcessNamespace: boolean; ``` Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. This field is beta-level and may be disabled with the PodShareProcessNamespace feature.

property subdomain

```typescript subdomain: string; ``` If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.

property terminationGracePeriodSeconds

```typescript terminationGracePeriodSeconds: number; ``` 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.

property tolerations

```typescript tolerations: Toleration[]; ``` If specified, the pod's tolerations.

property volumes

```typescript volumes: Volume[]; ``` List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

interface PodStatus

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.

property conditions

```typescript conditions: PodCondition[]; ``` Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

property containerStatuses

```typescript containerStatuses: ContainerStatus[]; ``` 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

property hostIP

```typescript hostIP: string; ``` IP address of the host to which the pod is assigned. Empty if not yet scheduled.

property initContainerStatuses

```typescript initContainerStatuses: ContainerStatus[]; ``` 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

property message

```typescript message: string; ``` A human readable message indicating details about why the pod is in this condition.

property nominatedNodeName

```typescript nominatedNodeName: string; ``` 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.

property phase

```typescript phase: string; ``` 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

property podIP

```typescript podIP: string; ``` IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.

property qosClass

```typescript qosClass: string; ``` 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

property reason

```typescript reason: string; ``` A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'

property startTime

```typescript startTime: string; ``` RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

interface PodTemplate

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

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property template

```typescript template: PodTemplateSpec; ``` Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface PodTemplateList

PodTemplateList is a list of PodTemplates.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: PodTemplate[]; ``` List of pod templates

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface PodTemplateSpec

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

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

```typescript spec: PodSpec; ``` Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface PortworxVolumeSource

PortworxVolumeSource represents a Portworx volume resource.

property fsType

```typescript fsType: string; ``` FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.

property readOnly

```typescript readOnly: boolean; ``` Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property volumeID

```typescript volumeID: string; ``` VolumeID uniquely identifies a Portworx volume

interface PreferredSchedulingTerm

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).

property preference

```typescript preference: NodeSelectorTerm; ``` A node selector term, associated with the corresponding weight.

property weight

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

interface Probe

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

property exec

```typescript exec: ExecAction; ``` One and only one of the following should be specified. Exec specifies the action to take.

property failureThreshold

```typescript failureThreshold: number; ``` Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

property httpGet

```typescript httpGet: HTTPGetAction; ``` HTTPGet specifies the http request to perform.

property initialDelaySeconds

```typescript initialDelaySeconds: number; ``` 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

property periodSeconds

```typescript periodSeconds: number; ``` How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

property successThreshold

```typescript successThreshold: number; ``` Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

property tcpSocket

```typescript tcpSocket: TCPSocketAction; ``` TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

property timeoutSeconds

```typescript timeoutSeconds: number; ``` 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

interface ProjectedVolumeSource

Represents a projected volume source

property defaultMode

```typescript defaultMode: number; ``` Mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property sources

```typescript sources: VolumeProjection[]; ``` list of volume projections

interface QuobyteVolumeSource

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

property group

```typescript group: string; ``` Group to map volume access to Default is no group

property readOnly

```typescript readOnly: boolean; ``` ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

property registry

```typescript registry: string; ``` Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

property user

```typescript user: string; ``` User to map volume access to Defaults to serivceaccount user

property volume

```typescript volume: string; ``` Volume is a string that references an already created Quobyte volume by name.

interface RBDPersistentVolumeSource

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

property fsType

```typescript fsType: string; ``` 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

property image

```typescript image: string; ``` The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property keyring

```typescript keyring: string; ``` Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property monitors

```typescript monitors: string[]; ``` A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property pool

```typescript pool: string; ``` The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property readOnly

```typescript readOnly: boolean; ``` ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property secretRef

```typescript secretRef: SecretReference; ``` SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property user

```typescript user: string; ``` The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

interface RBDVolumeSource

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

property fsType

```typescript fsType: string; ``` 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

property image

```typescript image: string; ``` The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property keyring

```typescript keyring: string; ``` Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property monitors

```typescript monitors: string[]; ``` A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property pool

```typescript pool: string; ``` The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property readOnly

```typescript readOnly: boolean; ``` ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property secretRef

```typescript secretRef: LocalObjectReference; ``` SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

property user

```typescript user: string; ``` The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

interface ReplicationController

ReplicationController represents the configuration of a replication controller.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

```typescript spec: ReplicationControllerSpec; ``` Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

```typescript status: ReplicationControllerStatus; ``` Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface ReplicationControllerCondition

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

property lastTransitionTime

```typescript lastTransitionTime: string; ``` The last time the condition transitioned from one status to another.

property message

```typescript message: string; ``` A human readable message indicating details about the transition.

property reason

```typescript reason: string; ``` The reason for the condition's last transition.

property status

```typescript status: string; ``` Status of the condition, one of True, False, Unknown.

property type

```typescript type: string; ``` Type of replication controller condition.

interface ReplicationControllerList

ReplicationControllerList is a collection of replication controllers.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: ReplicationController[]; ``` List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface ReplicationControllerSpec

ReplicationControllerSpec is the specification of a replication controller.

property minReadySeconds

```typescript minReadySeconds: number; ``` 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)

property replicas

```typescript replicas: number; ``` 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

property selector

```typescript 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

property template

```typescript template: PodTemplateSpec; ``` Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

interface ReplicationControllerStatus

ReplicationControllerStatus represents the current status of a replication controller.

property availableReplicas

```typescript availableReplicas: number; ``` The number of available replicas (ready for at least minReadySeconds) for this replication controller.

property conditions

```typescript conditions: ReplicationControllerCondition[]; ``` Represents the latest available observations of a replication controller's current state.

property fullyLabeledReplicas

```typescript fullyLabeledReplicas: number; ``` The number of pods that have labels matching the labels of the pod template of the replication controller.

property observedGeneration

```typescript observedGeneration: number; ``` ObservedGeneration reflects the generation of the most recently observed replication controller.

property readyReplicas

```typescript readyReplicas: number; ``` The number of ready replicas for this replication controller.

property replicas

```typescript replicas: number; ``` Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

interface ResourceFieldSelector

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

property containerName

```typescript containerName: string; ``` Container name: required for volumes, optional for env vars

property divisor

```typescript divisor: string; ``` Specifies the output format of the exposed resources, defaults to "1"

property resource

```typescript resource: string; ``` Required: resource to select

interface ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

```typescript spec: ResourceQuotaSpec; ``` Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

```typescript status: ResourceQuotaStatus; ``` Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface ResourceQuotaList

ResourceQuotaList is a list of ResourceQuota items.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: ResourceQuota[]; ``` Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

property hard

```typescript hard: object; ``` hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

property scopeSelector

```typescript scopeSelector: ScopeSelector; ``` scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.

property scopes

```typescript scopes: string[]; ``` A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

interface ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

property hard

```typescript hard: object; ``` Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

property used

```typescript used: object; ``` Used is the current observed total usage of the resource in the namespace.

interface ResourceRequirements

ResourceRequirements describes the compute resource requirements.

property limits

```typescript limits: object; ``` Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

property requests

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

interface SELinuxOptions

SELinuxOptions are the labels to be applied to the container

property level

```typescript level: string; ``` Level is SELinux level label that applies to the container.

property role

```typescript role: string; ``` Role is a SELinux role label that applies to the container.

property type

```typescript type: string; ``` Type is a SELinux type label that applies to the container.

property user

```typescript user: string; ``` User is a SELinux user label that applies to the container.

interface ScaleIOPersistentVolumeSource

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

property fsType

```typescript fsType: string; ``` Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"

property gateway

```typescript gateway: string; ``` The host address of the ScaleIO API Gateway.

property protectionDomain

```typescript protectionDomain: string; ``` The name of the ScaleIO Protection Domain for the configured storage.

property readOnly

```typescript readOnly: boolean; ``` Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

```typescript secretRef: SecretReference; ``` SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

property sslEnabled

```typescript sslEnabled: boolean; ``` Flag to enable/disable SSL communication with Gateway, default false

property storageMode

```typescript storageMode: string; ``` Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

property storagePool

```typescript storagePool: string; ``` The ScaleIO Storage Pool associated with the protection domain.

property system

```typescript system: string; ``` The name of the storage system as configured in ScaleIO.

property volumeName

```typescript volumeName: string; ``` The name of a volume already created in the ScaleIO system that is associated with this volume source.

interface ScaleIOVolumeSource

ScaleIOVolumeSource represents a persistent ScaleIO volume

property fsType

```typescript fsType: string; ``` Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".

property gateway

```typescript gateway: string; ``` The host address of the ScaleIO API Gateway.

property protectionDomain

```typescript protectionDomain: string; ``` The name of the ScaleIO Protection Domain for the configured storage.

property readOnly

```typescript readOnly: boolean; ``` Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

```typescript secretRef: LocalObjectReference; ``` SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

property sslEnabled

```typescript sslEnabled: boolean; ``` Flag to enable/disable SSL communication with Gateway, default false

property storageMode

```typescript storageMode: string; ``` Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

property storagePool

```typescript storagePool: string; ``` The ScaleIO Storage Pool associated with the protection domain.

property system

```typescript system: string; ``` The name of the storage system as configured in ScaleIO.

property volumeName

```typescript volumeName: string; ``` The name of a volume already created in the ScaleIO system that is associated with this volume source.

interface ScopeSelector

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

property matchExpressions

```typescript matchExpressions: ScopedResourceSelectorRequirement[]; ``` A list of scope selector requirements by scope of the resources.

interface ScopedResourceSelectorRequirement

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

property operator

```typescript operator: string; ``` Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.

property scopeName

```typescript scopeName: string; ``` The name of the scope that the selector applies to.

property values

```typescript values: string[]; ``` An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

interface Secret

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

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property data

```typescript data: object; ``` 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

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property stringData

```typescript 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.

property type

```typescript type: string; ``` Used to facilitate programmatic handling of secret data.

interface SecretEnvSource

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.

property name

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

property optional

```typescript optional: boolean; ``` Specify whether the Secret must be defined

interface SecretKeySelector

SecretKeySelector selects a key of a Secret.

property key

```typescript key: string; ``` The key of the secret to select from. Must be a valid secret key.

property name

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

property optional

```typescript optional: boolean; ``` Specify whether the Secret or it's key must be defined

interface SecretList

SecretList is a list of Secret.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: Secret[]; ``` Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface SecretProjection

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.

property items

```typescript items: KeyToPath[]; ``` 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 '..'.

property name

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

property optional

```typescript optional: boolean; ``` Specify whether the Secret or its key must be defined

interface SecretReference

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

property name

```typescript name: string; ``` Name is unique within a namespace to reference a secret resource.

property namespace

```typescript namespace: string; ``` Namespace defines the space within which the secret name must be unique.

interface SecretVolumeSource

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.

property defaultMode

```typescript defaultMode: number; ``` Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

property items

```typescript items: KeyToPath[]; ``` 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 '..'.

property optional

```typescript optional: boolean; ``` Specify whether the Secret or it's keys must be defined

property secretName

```typescript secretName: string; ``` Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

interface SecurityContext

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.

property allowPrivilegeEscalation

```typescript allowPrivilegeEscalation: boolean; ``` AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN

property capabilities

```typescript capabilities: Capabilities; ``` The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

property privileged

```typescript privileged: boolean; ``` Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

property procMount

```typescript procMount: string; ``` 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.

property readOnlyRootFilesystem

```typescript readOnlyRootFilesystem: boolean; ``` Whether this container has a read-only root filesystem. Default is false.

property runAsGroup

```typescript runAsGroup: number; ``` 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.

property runAsNonRoot

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

property runAsUser

```typescript runAsUser: number; ``` 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.

property seLinuxOptions

```typescript seLinuxOptions: SELinuxOptions; ``` The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

interface Service

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.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

```typescript spec: ServiceSpec; ``` Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

```typescript status: ServiceStatus; ``` Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface ServiceAccount

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

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property automountServiceAccountToken

```typescript automountServiceAccountToken: boolean; ``` AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.

property imagePullSecrets

```typescript imagePullSecrets: LocalObjectReference[]; ``` 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

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

```typescript metadata: ObjectMeta; ``` Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property secrets

```typescript secrets: ObjectReference[]; ``` 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

interface ServiceAccountList

ServiceAccountList is a list of ServiceAccount objects

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: ServiceAccount[]; ``` List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface ServiceAccountTokenProjection

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).

property audience

```typescript audience: string; ``` Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

property expirationSeconds

```typescript expirationSeconds: number; ``` 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.

property path

```typescript path: string; ``` Path is the path relative to the mount point of the file to project the token into.

interface ServiceList

ServiceList holds a list of services.

property apiVersion

```typescript apiVersion: string; ``` APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

```typescript items: Service[]; ``` List of services

property kind

```typescript kind: string; ``` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

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

interface ServicePort

ServicePort contains information on service's port.

property name

```typescript name: string; ``` The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.

property nodePort

```typescript nodePort: number; ``` The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

property port

```typescript port: number; ``` The port that will be exposed by this service.

property protocol

```typescript protocol: string; ``` The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

property targetPort

```typescript targetPort: number | string; ``` Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service

interface ServiceSpec

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

property clusterIP

```typescript clusterIP: string; ``` clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

property externalIPs

```typescript externalIPs: string[]; ``` 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.

property externalName

```typescript externalName: string; ``` externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.

property externalTrafficPolicy

```typescript externalTrafficPolicy: string; ``` 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.

property healthCheckNodePort

```typescript healthCheckNodePort: number; ``` healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.

property loadBalancerIP

```typescript loadBalancerIP: string; ``` 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.

property loadBalancerSourceRanges

```typescript loadBalancerSourceRanges: string[]; ``` 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/

property ports

```typescript ports: ServicePort[]; ``` 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

property publishNotReadyAddresses

```typescript publishNotReadyAddresses: boolean; ``` publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery.

property selector

```typescript 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/

property sessionAffinity

```typescript sessionAffinity: string; ``` 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

property sessionAffinityConfig

```typescript sessionAffinityConfig: SessionAffinityConfig; ``` sessionAffinityConfig contains the configurations of session affinity.

property type

```typescript type: string; ``` type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "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. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types

interface ServiceStatus

ServiceStatus represents the current status of a service.

property loadBalancer

```typescript loadBalancer: LoadBalancerStatus; ``` LoadBalancer contains the current status of the load-balancer, if one is present.

interface SessionAffinityConfig

SessionAffinityConfig represents the configurations of session affinity.

property clientIP

```typescript clientIP: ClientIPConfig; ``` clientIP contains the configurations of Client IP based session affinity.

interface StorageOSPersistentVolumeSource

Represents a StorageOS persistent volume resource.

property fsType

```typescript fsType: string; ``` 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.

property readOnly

```typescript readOnly: boolean; ``` Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

```typescript secretRef: ObjectReference; ``` SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

property volumeName

```typescript volumeName: string; ``` VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

property volumeNamespace

```typescript volumeNamespace: string; ``` VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

interface StorageOSVolumeSource

Represents a StorageOS persistent volume resource.

property fsType

```typescript fsType: string; ``` 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.

property readOnly

```typescript readOnly: boolean; ``` Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

property secretRef

```typescript secretRef: LocalObjectReference; ``` SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

property volumeName

```typescript volumeName: string; ``` VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

property volumeNamespace

```typescript volumeNamespace: string; ``` VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

interface Sysctl

Sysctl defines a kernel parameter to be set

property name

```typescript name: string; ``` Name of a property to set

property value

```typescript value: string; ``` Value of a property to set

interface TCPSocketAction

TCPSocketAction describes an action based on opening a socket

property host

```typescript host: string; ``` Optional: Host name to connect to, defaults to the pod IP.

property port

```typescript port: number | string; ``` Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

interface Taint

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

property effect

```typescript effect: string; ``` Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

property key

```typescript key: string; ``` Required. The taint key to be applied to a node.

property timeAdded

```typescript timeAdded: string; ``` TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.

property value

```typescript value: string; ``` Required. The taint value corresponding to the taint key.

interface Toleration

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

property effect

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

property key

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

property operator

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

property tolerationSeconds

```typescript tolerationSeconds: number; ``` 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.

property value

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

interface TopologySelectorLabelRequirement

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

property key

```typescript key: string; ``` The label key that the selector applies to.

property values

```typescript values: string[]; ``` An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

interface TopologySelectorTerm

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.

property matchLabelExpressions

```typescript matchLabelExpressions: TopologySelectorLabelRequirement[]; ``` A list of topology selector requirements by labels.

interface TypedLocalObjectReference

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

property apiGroup

```typescript apiGroup: string; ``` APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

property kind

```typescript kind: string; ``` Kind is the type of resource being referenced

property name

```typescript name: string; ``` Name is the name of resource being referenced

interface Volume

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

property awsElasticBlockStore

```typescript awsElasticBlockStore: AWSElasticBlockStoreVolumeSource; ``` AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

property azureDisk

```typescript azureDisk: AzureDiskVolumeSource; ``` AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

property azureFile

```typescript azureFile: AzureFileVolumeSource; ``` AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

property cephfs

```typescript cephfs: CephFSVolumeSource; ``` CephFS represents a Ceph FS mount on the host that shares a pod's lifetime

property cinder

```typescript cinder: CinderVolumeSource; ``` Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

property configMap

```typescript configMap: ConfigMapVolumeSource; ``` ConfigMap represents a configMap that should populate this volume

property downwardAPI

```typescript downwardAPI: DownwardAPIVolumeSource; ``` DownwardAPI represents downward API about the pod that should populate this volume

property emptyDir

```typescript emptyDir: EmptyDirVolumeSource; ``` EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

property fc

```typescript fc: FCVolumeSource; ``` FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

property flexVolume

```typescript flexVolume: FlexVolumeSource; ``` FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

property flocker

```typescript flocker: FlockerVolumeSource; ``` Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

property gcePersistentDisk

```typescript gcePersistentDisk: GCEPersistentDiskVolumeSource; ``` GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

property gitRepo

```typescript gitRepo: GitRepoVolumeSource; ``` GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

property glusterfs

```typescript glusterfs: GlusterfsVolumeSource; ``` Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

property hostPath

```typescript hostPath: HostPathVolumeSource; ``` HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

property iscsi

```typescript iscsi: ISCSIVolumeSource; ``` ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md

property name

```typescript name: string; ``` 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

property nfs

```typescript nfs: NFSVolumeSource; ``` NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

property persistentVolumeClaim

```typescript persistentVolumeClaim: PersistentVolumeClaimVolumeSource; ``` PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

property photonPersistentDisk

```typescript photonPersistentDisk: PhotonPersistentDiskVolumeSource; ``` PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

property portworxVolume

```typescript portworxVolume: PortworxVolumeSource; ``` PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

property projected

```typescript projected: ProjectedVolumeSource; ``` Items for all in one resources secrets, configmaps, and downward API

property quobyte

```typescript quobyte: QuobyteVolumeSource; ``` Quobyte represents a Quobyte mount on the host that shares a pod's lifetime

property rbd

```typescript rbd: RBDVolumeSource; ``` RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

property scaleIO

```typescript scaleIO: ScaleIOVolumeSource; ``` ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

property secret

```typescript secret: SecretVolumeSource; ``` Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

property storageos

```typescript storageos: StorageOSVolumeSource; ``` StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

property vsphereVolume

```typescript vsphereVolume: VsphereVirtualDiskVolumeSource; ``` VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

interface VolumeDevice

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

property devicePath

```typescript devicePath: string; ``` devicePath is the path inside of the container that the device will be mapped to.

property name

```typescript name: string; ``` name must match the name of a persistentVolumeClaim in the pod

interface VolumeMount

VolumeMount describes a mounting of a Volume within a container.

property mountPath

```typescript mountPath: string; ``` Path within the container at which the volume should be mounted. Must not contain ':'.

property mountPropagation

```typescript mountPropagation: string; ``` mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

property name

```typescript name: string; ``` This must match the Name of a Volume.

property readOnly

```typescript readOnly: boolean; ``` Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

property subPath

```typescript subPath: string; ``` Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

interface VolumeNodeAffinity

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

property required

```typescript required: NodeSelector; ``` Required specifies hard node constraints that must be met.

interface VolumeProjection

Projection that may be projected along with other supported volume types

property configMap

```typescript configMap: ConfigMapProjection; ``` information about the configMap data to project

property downwardAPI

```typescript downwardAPI: DownwardAPIProjection; ``` information about the downwardAPI data to project

property secret

```typescript secret: SecretProjection; ``` information about the secret data to project

property serviceAccountToken

```typescript serviceAccountToken: ServiceAccountTokenProjection; ``` information about the serviceAccountToken data to project

interface VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

property fsType

```typescript fsType: string; ``` 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.

property storagePolicyID

```typescript storagePolicyID: string; ``` Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

property storagePolicyName

```typescript storagePolicyName: string; ``` Storage Policy Based Management (SPBM) profile name.

property volumePath

```typescript volumePath: string; ``` Path that identifies vSphere volume vmdk

interface WeightedPodAffinityTerm

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

property podAffinityTerm

```typescript podAffinityTerm: PodAffinityTerm; ``` Required. A pod affinity term, associated with the corresponding weight.

property weight

```typescript weight: number; ``` weight associated with matching the corresponding podAffinityTerm, in the range 1-100.