core_v1

AWSElasticBlockStoreVolumeSource

class lightkube.models.core_v1.AWSElasticBlockStoreVolumeSource(volumeID, fsType=None, partition=None, readOnly=None)

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.

parameters

• volumeID str - volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info
• fsType Optional[str] - fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• partition Optional[int] - partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
• readOnly Optional[bool] - readOnly value true will force the readOnly setting in VolumeMounts. More info

Affinity

class lightkube.models.core_v1.Affinity(nodeAffinity=None, podAffinity=None, podAntiAffinity=None)

Affinity is a group of affinity scheduling rules.

parameters

• nodeAffinity Optional[NodeAffinity] - Describes node affinity scheduling rules for the pod.
• podAffinity Optional[PodAffinity] - Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
• podAntiAffinity Optional[PodAntiAffinity] - Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

AppArmorProfile

class lightkube.models.core_v1.AppArmorProfile(type, localhostProfile=None)

AppArmorProfile defines a pod or container's AppArmor settings.

parameters

• type str - type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
• localhostProfile Optional[str] - localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

AttachedVolume

class lightkube.models.core_v1.AttachedVolume(devicePath, name)

AttachedVolume describes a volume attached to a node

parameters

• devicePath str - DevicePath represents the device path where the volume should be available
• name str - Name of the attached volume

AzureDiskVolumeSource

class lightkube.models.core_v1.AzureDiskVolumeSource(diskName, diskURI, cachingMode=None, fsType=None, kind=None, readOnly=None)

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

parameters

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

AzureFilePersistentVolumeSource

class lightkube.models.core_v1.AzureFilePersistentVolumeSource(secretName, shareName, readOnly=None, secretNamespace=None)

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

parameters

• secretName str - secretName is the name of secret that contains Azure Storage Account Name and Key
• shareName str - shareName is the azure Share Name
• readOnly Optional[bool] - readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
• secretNamespace Optional[str] - secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod

AzureFileVolumeSource

class lightkube.models.core_v1.AzureFileVolumeSource(secretName, shareName, readOnly=None)

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

parameters

• secretName str - secretName is the name of secret that contains Azure Storage Account Name and Key
• shareName str - shareName is the azure share Name
• readOnly Optional[bool] - readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Binding

class lightkube.models.core_v1.Binding(target, apiVersion=None, kind=None, metadata=None)

Binding ties one object to another; for example, a pod is bound to a node by a scheduler.

parameters

• target ObjectReference - The target object that you want to bind to the standard object.
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info

CSIPersistentVolumeSource

class lightkube.models.core_v1.CSIPersistentVolumeSource(driver, volumeHandle, controllerExpandSecretRef=None, controllerPublishSecretRef=None, fsType=None, nodeExpandSecretRef=None, nodePublishSecretRef=None, nodeStageSecretRef=None, readOnly=None, volumeAttributes=None)

Represents storage that is managed by an external CSI volume driver

parameters

• driver str - driver is the name of the driver to use for this volume. Required.
• volumeHandle str - volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
• controllerExpandSecretRef Optional[SecretReference] - controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. 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.
• controllerPublishSecretRef Optional[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.
• fsType Optional[str] - fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
• nodeExpandSecretRef Optional[SecretReference] - nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed.
• nodePublishSecretRef Optional[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.
• nodeStageSecretRef Optional[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.
• readOnly Optional[bool] - readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
• volumeAttributes Optional[dict] - volumeAttributes of the volume to publish.

CSIVolumeSource

class lightkube.models.core_v1.CSIVolumeSource(driver, fsType=None, nodePublishSecretRef=None, readOnly=None, volumeAttributes=None)

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

parameters

• driver str - driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
• fsType Optional[str] - fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
• nodePublishSecretRef Optional[LocalObjectReference] - nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
• readOnly Optional[bool] - readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
• volumeAttributes Optional[dict] - volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

Capabilities

class lightkube.models.core_v1.Capabilities(add=None, drop=None)

Adds and removes POSIX capabilities from running containers.

parameters

• add Optional[List[str]] - Added capabilities
• drop Optional[List[str]] - Removed capabilities

CephFSPersistentVolumeSource

class lightkube.models.core_v1.CephFSPersistentVolumeSource(monitors, path=None, readOnly=None, secretFile=None, secretRef=None, user=None)

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

parameters

• monitors List[str] - monitors is Required: Monitors is a collection of Ceph monitors More info
• path Optional[str] - path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
• readOnly Optional[bool] - readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info
• secretFile Optional[str] - secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info
• secretRef Optional[SecretReference] - secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info
• user Optional[str] - user is Optional: User is the rados user name, default is admin More info

CephFSVolumeSource

class lightkube.models.core_v1.CephFSVolumeSource(monitors, path=None, readOnly=None, secretFile=None, secretRef=None, user=None)

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

parameters

• monitors List[str] - monitors is Required: Monitors is a collection of Ceph monitors More info
• path Optional[str] - path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
• readOnly Optional[bool] - readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info
• secretFile Optional[str] - secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info
• secretRef Optional[LocalObjectReference] - secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info
• user Optional[str] - user is optional: User is the rados user name, default is admin More info

CinderPersistentVolumeSource

class lightkube.models.core_v1.CinderPersistentVolumeSource(volumeID, fsType=None, readOnly=None, secretRef=None)

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.

parameters

• volumeID str - volumeID used to identify the volume in cinder. More info
• fsType Optional[str] - fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• readOnly Optional[bool] - readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info
• secretRef Optional[SecretReference] - secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.

CinderVolumeSource

class lightkube.models.core_v1.CinderVolumeSource(volumeID, fsType=None, readOnly=None, secretRef=None)

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.

parameters

• volumeID str - volumeID used to identify the volume in cinder. More info
• fsType Optional[str] - fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• readOnly Optional[bool] - readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info
• secretRef Optional[LocalObjectReference] - secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

ClientIPConfig

class lightkube.models.core_v1.ClientIPConfig(timeoutSeconds=None)

ClientIPConfig represents the configurations of Client IP based session affinity.

parameters

• timeoutSeconds Optional[int] - 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).

ClusterTrustBundleProjection

class lightkube.models.core_v1.ClusterTrustBundleProjection(path, labelSelector=None, name=None, optional=None, signerName=None)

ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.

parameters

• path str - Relative path from the volume root to write the bundle.
• labelSelector Optional[meta_v1.LabelSelector] - Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
• name Optional[str] - Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
• optional Optional[bool] - If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
• signerName Optional[str] - Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

ComponentCondition

class lightkube.models.core_v1.ComponentCondition(status, type, error=None, message=None)

Information about the condition of a component.

parameters

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

ComponentStatus

class lightkube.models.core_v1.ComponentStatus(apiVersion=None, conditions=None, kind=None, metadata=None)

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

parameters

• apiVersion Optional[str] - 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
• conditions Optional[List[ComponentCondition]] - List of component conditions observed
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info

ComponentStatusList

class lightkube.models.core_v1.ComponentStatusList(items, apiVersion=None, kind=None, metadata=None)

Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+

parameters

• items List[ComponentStatus] - List of ComponentStatus objects.
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

ConfigMap

class lightkube.models.core_v1.ConfigMap(apiVersion=None, binaryData=None, data=None, immutable=None, kind=None, metadata=None)

ConfigMap holds configuration data for pods to consume.

parameters

• apiVersion Optional[str] - 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
• binaryData Optional[dict] - BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
• data Optional[dict] - Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
• immutable Optional[bool] - Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info

ConfigMapEnvSource

class lightkube.models.core_v1.ConfigMapEnvSource(name=None, optional=None)

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.

parameters

• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info
• optional Optional[bool] - Specify whether the ConfigMap must be defined

ConfigMapKeySelector

class lightkube.models.core_v1.ConfigMapKeySelector(key, name=None, optional=None)

Selects a key from a ConfigMap.

parameters

• key str - The key to select.
• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info
• optional Optional[bool] - Specify whether the ConfigMap or its key must be defined

ConfigMapList

class lightkube.models.core_v1.ConfigMapList(items, apiVersion=None, kind=None, metadata=None)

ConfigMapList is a resource containing a list of ConfigMap objects.

parameters

• items List[ConfigMap] - Items is the list of ConfigMaps.
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - More info

ConfigMapNodeConfigSource

class lightkube.models.core_v1.ConfigMapNodeConfigSource(kubeletConfigKey, name, namespace, resourceVersion=None, uid=None)

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

parameters

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

ConfigMapProjection

class lightkube.models.core_v1.ConfigMapProjection(items=None, name=None, optional=None)

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.

parameters

• items Optional[List[KeyToPath]] - items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info
• optional Optional[bool] - optional specify whether the ConfigMap or its keys must be defined

ConfigMapVolumeSource

class lightkube.models.core_v1.ConfigMapVolumeSource(defaultMode=None, items=None, name=None, optional=None)

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.

parameters

• defaultMode Optional[int] - defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
• items Optional[List[KeyToPath]] - items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info
• optional Optional[bool] - optional specify whether the ConfigMap or its keys must be defined

Container

class lightkube.models.core_v1.Container(name, args=None, command=None, env=None, envFrom=None, image=None, imagePullPolicy=None, lifecycle=None, livenessProbe=None, ports=None, readinessProbe=None, resizePolicy=None, resources=None, restartPolicy=None, securityContext=None, startupProbe=None, stdin=None, stdinOnce=None, terminationMessagePath=None, terminationMessagePolicy=None, tty=None, volumeDevices=None, volumeMounts=None, workingDir=None)

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

parameters

• name str - Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
• args Optional[List[str]] - Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info
• command Optional[List[str]] - Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info
• env Optional[List[EnvVar]] - List of environment variables to set in the container. Cannot be updated.
• envFrom Optional[List[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.
• image Optional[str] - Container image name. More info This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
• imagePullPolicy Optional[str] - Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info
• lifecycle Optional[Lifecycle] - Actions that the management system should take in response to container lifecycle events. Cannot be updated.
• livenessProbe Optional[Probe] - Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info
• ports Optional[List[ContainerPort]] - List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
• readinessProbe Optional[Probe] - Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info
• resizePolicy Optional[List[ContainerResizePolicy]] - Resources resize policy for the container.
• resources Optional[ResourceRequirements] - Compute Resources required by this container. Cannot be updated. More info
• restartPolicy Optional[str] - RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
• securityContext Optional[SecurityContext] - SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info
• startupProbe Optional[Probe] - StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info
• stdin Optional[bool] - Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
• stdinOnce Optional[bool] - Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
• terminationMessagePath Optional[str] - Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
• terminationMessagePolicy Optional[str] - Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
• tty Optional[bool] - Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
• volumeDevices Optional[List[VolumeDevice]] - volumeDevices is the list of block devices to be used by the container.
• volumeMounts Optional[List[VolumeMount]] - Pod volumes to mount into the container's filesystem. Cannot be updated.
• workingDir Optional[str] - 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.

ContainerImage

class lightkube.models.core_v1.ContainerImage(names=None, sizeBytes=None)

Describe a container image

parameters

• names Optional[List[str]] - Names by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
• sizeBytes Optional[int] - The size of the image in bytes.

ContainerPort

class lightkube.models.core_v1.ContainerPort(containerPort, hostIP=None, hostPort=None, name=None, protocol=None)

ContainerPort represents a network port in a single container.

parameters

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

ContainerResizePolicy

class lightkube.models.core_v1.ContainerResizePolicy(resourceName, restartPolicy)

ContainerResizePolicy represents resource resize policy for the container.

parameters

• resourceName str - Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
• restartPolicy str - Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

ContainerState

class lightkube.models.core_v1.ContainerState(running=None, terminated=None, waiting=None)

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.

parameters

• running Optional[ContainerStateRunning] - Details about a running container
• terminated Optional[ContainerStateTerminated] - Details about a terminated container
• waiting Optional[ContainerStateWaiting] - Details about a waiting container

ContainerStateRunning

class lightkube.models.core_v1.ContainerStateRunning(startedAt=None)

ContainerStateRunning is a running state of a container.

parameters

• startedAt Optional[meta_v1.Time] - Time at which the container was last (re-)started

ContainerStateTerminated

class lightkube.models.core_v1.ContainerStateTerminated(exitCode, containerID=None, finishedAt=None, message=None, reason=None, signal=None, startedAt=None)

ContainerStateTerminated is a terminated state of a container.

parameters

• exitCode int - Exit status from the last termination of the container
• containerID Optional[str] - Container's ID in the format '://'
• finishedAt Optional[meta_v1.Time] - Time at which the container last terminated
• message Optional[str] - Message regarding the last termination of the container
• reason Optional[str] - (brief) reason from the last termination of the container
• signal Optional[int] - Signal from the last termination of the container
• startedAt Optional[meta_v1.Time] - Time at which previous execution of the container started

ContainerStateWaiting

class lightkube.models.core_v1.ContainerStateWaiting(message=None, reason=None)

ContainerStateWaiting is a waiting state of a container.

parameters

• message Optional[str] - Message regarding why the container is not yet running.
• reason Optional[str] - (brief) reason the container is not yet running.

ContainerStatus

class lightkube.models.core_v1.ContainerStatus(image, imageID, name, ready, restartCount, allocatedResources=None, allocatedResourcesStatus=None, containerID=None, lastState=None, resources=None, started=None, state=None, stopSignal=None, user=None, volumeMounts=None)

ContainerStatus contains details for the current status of this container.

parameters

• image str - Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info
• imageID str - ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.
• name str - Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.
• ready bool - Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field). The value is typically used to determine whether a container is ready to accept traffic.
• restartCount int - RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.
• allocatedResources Optional[dict] - AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.
• allocatedResourcesStatus Optional[List[ResourceStatus]] - AllocatedResourcesStatus represents the status of various resources allocated for this Pod.
• containerID Optional[str] - ContainerID is the ID of the container in the format '://'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").
• lastState Optional[ContainerState] - LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.
• resources Optional[ResourceRequirements] - Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.
• started Optional[bool] - Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.
• state Optional[ContainerState] - State holds details about the container's current condition.
• stopSignal Optional[str] - StopSignal reports the effective stop signal for this container
• user Optional[ContainerUser] - User represents user identity information initially attached to the first process of the container
• volumeMounts Optional[List[VolumeMountStatus]] - Status of volume mounts.

ContainerUser

class lightkube.models.core_v1.ContainerUser(linux=None)

ContainerUser represents user identity information

parameters

• linux Optional[LinuxContainerUser] - Linux holds user identity information initially attached to the first process of the containers in Linux. Note that the actual running identity can be changed if the process has enough privilege to do so.

DaemonEndpoint

class lightkube.models.core_v1.DaemonEndpoint(Port)

DaemonEndpoint contains information about a single Daemon endpoint.

parameters

• Port int - Port number of the given endpoint.

DownwardAPIProjection

class lightkube.models.core_v1.DownwardAPIProjection(items=None)

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

parameters

• items Optional[List[DownwardAPIVolumeFile]] - Items is a list of DownwardAPIVolume file

DownwardAPIVolumeFile

class lightkube.models.core_v1.DownwardAPIVolumeFile(path, fieldRef=None, mode=None, resourceFieldRef=None)

DownwardAPIVolumeFile represents information to create the file containing the pod field

parameters

• path str - 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 '..'
• fieldRef Optional[ObjectFieldSelector] - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
• mode Optional[int] - Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
• resourceFieldRef Optional[ResourceFieldSelector] - Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

DownwardAPIVolumeSource

class lightkube.models.core_v1.DownwardAPIVolumeSource(defaultMode=None, items=None)

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

parameters

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

EmptyDirVolumeSource

class lightkube.models.core_v1.EmptyDirVolumeSource(medium=None, sizeLimit=None)

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

parameters

• medium Optional[str] - medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info
• sizeLimit Optional[resource.Quantity] - sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info

EndpointAddress

class lightkube.models.core_v1.EndpointAddress(ip, hostname=None, nodeName=None, targetRef=None)

EndpointAddress is a tuple that describes single IP address. Deprecated: This API is deprecated in v1.33+.

parameters

• ip str - The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
• hostname Optional[str] - The Hostname of this endpoint
• nodeName Optional[str] - Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
• targetRef Optional[ObjectReference] - Reference to object providing the endpoint.

EndpointPort

class lightkube.models.core_v1.EndpointPort(port, appProtocol=None, name=None, protocol=None)

EndpointPort is a tuple that describes a single port. Deprecated: This API is deprecated in v1.33+.

parameters

• port int - The port number of the endpoint.
• appProtocol Optional[str] - The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
• Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
• Kubernetes-defined prefixed names:
  • 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
  • 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
  • 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
• Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
• name Optional[str] - The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
• protocol Optional[str] - The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.

EndpointSubset

class lightkube.models.core_v1.EndpointSubset(addresses=None, notReadyAddresses=None, ports=None)

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 ]

Deprecated: This API is deprecated in v1.33+.

parameters

• addresses Optional[List[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.
• notReadyAddresses Optional[List[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.
• ports Optional[List[EndpointPort]] - Port numbers available on the related IP addresses.

Endpoints

class lightkube.models.core_v1.Endpoints(apiVersion=None, kind=None, metadata=None, subsets=None)

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

Endpoints is a legacy API and does not contain information about all Service features. Use discoveryv1.EndpointSlice for complete information about Service endpoints.

Deprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• subsets Optional[List[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.

EndpointsList

class lightkube.models.core_v1.EndpointsList(items, apiVersion=None, kind=None, metadata=None)

EndpointsList is a list of endpoints. Deprecated: This API is deprecated in v1.33+.

parameters

• items List[Endpoints] - List of endpoints.
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

EnvFromSource

class lightkube.models.core_v1.EnvFromSource(configMapRef=None, prefix=None, secretRef=None)

EnvFromSource represents the source of a set of ConfigMaps or Secrets

parameters

• configMapRef Optional[ConfigMapEnvSource] - The ConfigMap to select from
• prefix Optional[str] - Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
• secretRef Optional[SecretEnvSource] - The Secret to select from

EnvVar

class lightkube.models.core_v1.EnvVar(name, value=None, valueFrom=None)

EnvVar represents an environment variable present in a Container.

parameters

• name str - Name of the environment variable. Must be a C_IDENTIFIER.
• value Optional[str] - Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
• valueFrom Optional[EnvVarSource] - Source for the environment variable's value. Cannot be used if value is not empty.

EnvVarSource

class lightkube.models.core_v1.EnvVarSource(configMapKeyRef=None, fieldRef=None, resourceFieldRef=None, secretKeyRef=None)

EnvVarSource represents a source for the value of an EnvVar.

parameters

• configMapKeyRef Optional[ConfigMapKeySelector] - Selects a key of a ConfigMap.
• fieldRef Optional[ObjectFieldSelector] - Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
• resourceFieldRef Optional[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.
• secretKeyRef Optional[SecretKeySelector] - Selects a key of a secret in the pod's namespace

EphemeralContainer

class lightkube.models.core_v1.EphemeralContainer(name, args=None, command=None, env=None, envFrom=None, image=None, imagePullPolicy=None, lifecycle=None, livenessProbe=None, ports=None, readinessProbe=None, resizePolicy=None, resources=None, restartPolicy=None, securityContext=None, startupProbe=None, stdin=None, stdinOnce=None, targetContainerName=None, terminationMessagePath=None, terminationMessagePolicy=None, tty=None, volumeDevices=None, volumeMounts=None, workingDir=None)

An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation.

To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.

parameters

• name str - Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
• args Optional[List[str]] - Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info
• command Optional[List[str]] - Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info
• env Optional[List[EnvVar]] - List of environment variables to set in the container. Cannot be updated.
• envFrom Optional[List[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.
• image Optional[str] - Container image name. More info
• imagePullPolicy Optional[str] - Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info
• lifecycle Optional[Lifecycle] - Lifecycle is not allowed for ephemeral containers.
• livenessProbe Optional[Probe] - Probes are not allowed for ephemeral containers.
• ports Optional[List[ContainerPort]] - Ports are not allowed for ephemeral containers.
• readinessProbe Optional[Probe] - Probes are not allowed for ephemeral containers.
• resizePolicy Optional[List[ContainerResizePolicy]] - Resources resize policy for the container.
• resources Optional[ResourceRequirements] - Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
• restartPolicy Optional[str] - Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers.
• securityContext Optional[SecurityContext] - Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
• startupProbe Optional[Probe] - Probes are not allowed for ephemeral containers.
• stdin Optional[bool] - Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
• stdinOnce Optional[bool] - Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
• targetContainerName Optional[str] - If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
• terminationMessagePath Optional[str] - Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
• terminationMessagePolicy Optional[str] - Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
• tty Optional[bool] - Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
• volumeDevices Optional[List[VolumeDevice]] - volumeDevices is the list of block devices to be used by the container.
• volumeMounts Optional[List[VolumeMount]] - Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
• workingDir Optional[str] - 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.

EphemeralVolumeSource

class lightkube.models.core_v1.EphemeralVolumeSource(volumeClaimTemplate=None)

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

parameters

• volumeClaimTemplate Optional[PersistentVolumeClaimTemplate] - Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

Event

class lightkube.models.core_v1.Event(involvedObject, metadata, action=None, apiVersion=None, count=None, eventTime=None, firstTimestamp=None, kind=None, lastTimestamp=None, message=None, reason=None, related=None, reportingComponent=None, reportingInstance=None, series=None, source=None, type=None)

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

parameters

• involvedObject ObjectReference - The object that this event is about.
• metadata meta_v1.ObjectMeta - Standard object's metadata. More info
• action Optional[str] - What action was taken/failed regarding to the Regarding object.
• apiVersion Optional[str] - 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
• count Optional[int] - The number of times this event has occurred.
• eventTime Optional[meta_v1.MicroTime] - Time when this Event was first observed.
• firstTimestamp Optional[meta_v1.Time] - The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
• kind Optional[str] - 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
• lastTimestamp Optional[meta_v1.Time] - The time at which the most recent occurrence of this event was recorded.
• message Optional[str] - A human-readable description of the status of this operation.
• reason Optional[str] - This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
• related Optional[ObjectReference] - Optional secondary object for more complex actions.
• reportingComponent Optional[str] - Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
• reportingInstance Optional[str] - ID of the controller instance, e.g. kubelet-xyzf.
• series Optional[EventSeries] - Data about the Event series this event represents or nil if it's a singleton Event.
• source Optional[EventSource] - The component reporting this event. Should be a short machine understandable string.
• type Optional[str] - Type of this event (Normal, Warning), new types could be added in the future

EventList

class lightkube.models.core_v1.EventList(items, apiVersion=None, kind=None, metadata=None)

EventList is a list of events.

parameters

• items List[Event] - List of events
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

EventSeries

class lightkube.models.core_v1.EventSeries(count=None, lastObservedTime=None)

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

parameters

• count Optional[int] - Number of occurrences in this series up to the last heartbeat time
• lastObservedTime Optional[meta_v1.MicroTime] - Time of the last occurrence observed

EventSource

class lightkube.models.core_v1.EventSource(component=None, host=None)

EventSource contains information for an event.

parameters

• component Optional[str] - Component from which the event is generated.
• host Optional[str] - Node name on which the event is generated.

ExecAction

class lightkube.models.core_v1.ExecAction(command=None)

ExecAction describes a "run in container" action.

parameters

• command Optional[List[str]] - 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.

FCVolumeSource

class lightkube.models.core_v1.FCVolumeSource(fsType=None, lun=None, readOnly=None, targetWWNs=None, wwids=None)

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.

parameters

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

FlexPersistentVolumeSource

class lightkube.models.core_v1.FlexPersistentVolumeSource(driver, fsType=None, options=None, readOnly=None, secretRef=None)

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

parameters

• driver str - driver is the name of the driver to use for this volume.
• fsType Optional[str] - fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
• options Optional[dict] - options is Optional: this field holds extra command options if any.
• readOnly Optional[bool] - readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
• secretRef Optional[SecretReference] - secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

FlexVolumeSource

class lightkube.models.core_v1.FlexVolumeSource(driver, fsType=None, options=None, readOnly=None, secretRef=None)

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

parameters

• driver str - driver is the name of the driver to use for this volume.
• fsType Optional[str] - fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
• options Optional[dict] - options is Optional: this field holds extra command options if any.
• readOnly Optional[bool] - readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
• secretRef Optional[LocalObjectReference] - secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

FlockerVolumeSource

class lightkube.models.core_v1.FlockerVolumeSource(datasetName=None, datasetUUID=None)

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.

parameters

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

GCEPersistentDiskVolumeSource

class lightkube.models.core_v1.GCEPersistentDiskVolumeSource(pdName, fsType=None, partition=None, readOnly=None)

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.

parameters

• pdName str - pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info
• fsType Optional[str] - fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• partition Optional[int] - partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info
• readOnly Optional[bool] - readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info

GRPCAction

class lightkube.models.core_v1.GRPCAction(port, service=None)

GRPCAction specifies an action involving a GRPC service.

parameters

• port int - Port number of the gRPC service. Number must be in the range 1 to 65535.
• service Optional[str] - Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.

GitRepoVolumeSource

class lightkube.models.core_v1.GitRepoVolumeSource(repository, directory=None, revision=None)

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.

parameters

• repository str - repository is the URL
• directory Optional[str] - directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
• revision Optional[str] - revision is the commit hash for the specified revision.

GlusterfsPersistentVolumeSource

class lightkube.models.core_v1.GlusterfsPersistentVolumeSource(endpoints, path, endpointsNamespace=None, readOnly=None)

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

parameters

• endpoints str - endpoints is the endpoint name that details Glusterfs topology. More info
• path str - path is the Glusterfs volume path. More info
• endpointsNamespace Optional[str] - 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
• readOnly Optional[bool] - readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info

GlusterfsVolumeSource

class lightkube.models.core_v1.GlusterfsVolumeSource(endpoints, path, readOnly=None)

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

parameters

• endpoints str - endpoints is the endpoint name that details Glusterfs topology. More info
• path str - path is the Glusterfs volume path. More info
• readOnly Optional[bool] - readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info

HTTPGetAction

class lightkube.models.core_v1.HTTPGetAction(port, host=None, httpHeaders=None, path=None, scheme=None)

HTTPGetAction describes an action based on HTTP Get requests.

parameters

• port util_intstr.IntOrString - Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
• host Optional[str] - Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
• httpHeaders Optional[List[HTTPHeader]] - Custom headers to set in the request. HTTP allows repeated headers.
• path Optional[str] - Path to access on the HTTP server.
• scheme Optional[str] - Scheme to use for connecting to the host. Defaults to HTTP.

HTTPHeader

class lightkube.models.core_v1.HTTPHeader(name, value)

HTTPHeader describes a custom header to be used in HTTP probes

parameters

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

HostAlias

class lightkube.models.core_v1.HostAlias(ip, hostnames=None)

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

parameters

• ip str - IP address of the host file entry.
• hostnames Optional[List[str]] - Hostnames for the above IP address.

HostIP

class lightkube.models.core_v1.HostIP(ip)

HostIP represents a single IP address allocated to the host.

parameters

• ip str - IP is the IP address assigned to the host

HostPathVolumeSource

class lightkube.models.core_v1.HostPathVolumeSource(path, type=None)

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

parameters

• path str - path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info
• type Optional[str] - type for HostPath Volume Defaults to "" More info

ISCSIPersistentVolumeSource

class lightkube.models.core_v1.ISCSIPersistentVolumeSource(iqn, lun, targetPortal, chapAuthDiscovery=None, chapAuthSession=None, fsType=None, initiatorName=None, iscsiInterface=None, portals=None, readOnly=None, secretRef=None)

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

parameters

• iqn str - iqn is Target iSCSI Qualified Name.
• lun int - lun is iSCSI Target Lun number.
• targetPortal str - targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
• chapAuthDiscovery Optional[bool] - chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
• chapAuthSession Optional[bool] - chapAuthSession defines whether support iSCSI Session CHAP authentication
• fsType Optional[str] - fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• initiatorName Optional[str] - initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
• iscsiInterface Optional[str] - iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
• portals Optional[List[str]] - portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
• readOnly Optional[bool] - readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
• secretRef Optional[SecretReference] - secretRef is the CHAP Secret for iSCSI target and initiator authentication

ISCSIVolumeSource

class lightkube.models.core_v1.ISCSIVolumeSource(iqn, lun, targetPortal, chapAuthDiscovery=None, chapAuthSession=None, fsType=None, initiatorName=None, iscsiInterface=None, portals=None, readOnly=None, secretRef=None)

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

parameters

• iqn str - iqn is the target iSCSI Qualified Name.
• lun int - lun represents iSCSI Target Lun number.
• targetPortal str - targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
• chapAuthDiscovery Optional[bool] - chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
• chapAuthSession Optional[bool] - chapAuthSession defines whether support iSCSI Session CHAP authentication
• fsType Optional[str] - fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• initiatorName Optional[str] - initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
• iscsiInterface Optional[str] - iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
• portals Optional[List[str]] - portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
• readOnly Optional[bool] - readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
• secretRef Optional[LocalObjectReference] - secretRef is the CHAP Secret for iSCSI target and initiator authentication

ImageVolumeSource

class lightkube.models.core_v1.ImageVolumeSource(pullPolicy=None, reference=None)

ImageVolumeSource represents a image volume resource.

parameters

• pullPolicy Optional[str] - Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
• reference Optional[str] - Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

KeyToPath

class lightkube.models.core_v1.KeyToPath(key, path, mode=None)

Maps a string key to a path within a volume.

parameters

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

Lifecycle

class lightkube.models.core_v1.Lifecycle(postStart=None, preStop=None, stopSignal=None)

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.

parameters

• postStart Optional[LifecycleHandler] - 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
• preStop Optional[LifecycleHandler] - PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info
• stopSignal Optional[str] - StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name

LifecycleHandler

class lightkube.models.core_v1.LifecycleHandler(exec=None, httpGet=None, sleep=None, tcpSocket=None)

LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.

parameters

• exec Optional[ExecAction] - Exec specifies a command to execute in the container.
• httpGet Optional[HTTPGetAction] - HTTPGet specifies an HTTP GET request to perform.
• sleep Optional[SleepAction] - Sleep represents a duration that the container should sleep.
• tcpSocket Optional[TCPSocketAction] - Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

LimitRange

class lightkube.models.core_v1.LimitRange(apiVersion=None, kind=None, metadata=None, spec=None)

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

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[LimitRangeSpec] - Spec defines the limits enforced. More info

LimitRangeItem

class lightkube.models.core_v1.LimitRangeItem(type, default=None, defaultRequest=None, max=None, maxLimitRequestRatio=None, min=None)

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

parameters

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

LimitRangeList

class lightkube.models.core_v1.LimitRangeList(items, apiVersion=None, kind=None, metadata=None)

LimitRangeList is a list of LimitRange items.

parameters

• items List[LimitRange] - Items is a list of LimitRange objects. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

LimitRangeSpec

class lightkube.models.core_v1.LimitRangeSpec(limits)

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

parameters

• limits List[LimitRangeItem] - Limits is the list of LimitRangeItem objects that are enforced.

LinuxContainerUser

class lightkube.models.core_v1.LinuxContainerUser(gid, uid, supplementalGroups=None)

LinuxContainerUser represents user identity information in Linux containers

parameters

• gid int - GID is the primary gid initially attached to the first process in the container
• uid int - UID is the primary uid initially attached to the first process in the container
• supplementalGroups Optional[List[int]] - SupplementalGroups are the supplemental groups initially attached to the first process in the container

LoadBalancerIngress

class lightkube.models.core_v1.LoadBalancerIngress(hostname=None, ip=None, ipMode=None, ports=None)

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

parameters

• hostname Optional[str] - Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
• ip Optional[str] - IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
• ipMode Optional[str] - IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port. Setting this to "Proxy" indicates that traffic is delivered to the node or pod with the destination set to the node's IP and node port or the pod's IP and port. Service implementations may use this information to adjust traffic routing.
• ports Optional[List[PortStatus]] - Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

LoadBalancerStatus

class lightkube.models.core_v1.LoadBalancerStatus(ingress=None)

LoadBalancerStatus represents the status of a load-balancer.

parameters

• ingress Optional[List[LoadBalancerIngress]] - Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

LocalObjectReference

class lightkube.models.core_v1.LocalObjectReference(name=None)

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

parameters

• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info

LocalVolumeSource

class lightkube.models.core_v1.LocalVolumeSource(path, fsType=None)

Local represents directly-attached storage with node affinity

parameters

• path str - path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
• fsType Optional[str] - fsType is the 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 filesystem if unspecified.

ModifyVolumeStatus

class lightkube.models.core_v1.ModifyVolumeStatus(status, targetVolumeAttributesClassName=None)

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation

parameters

• status str - status is the status of the ControllerModifyVolume operation. It can be in any of following states:
• Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing.
• InProgress InProgress indicates that the volume is being modified.
• Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
• targetVolumeAttributesClassName Optional[str] - targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

NFSVolumeSource

class lightkube.models.core_v1.NFSVolumeSource(path, server, readOnly=None)

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

parameters

• path str - path that is exported by the NFS server. More info
• server str - server is the hostname or IP address of the NFS server. More info
• readOnly Optional[bool] - readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info

Namespace

class lightkube.models.core_v1.Namespace(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

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

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[NamespaceSpec] - Spec defines the behavior of the Namespace. More info
• status Optional[NamespaceStatus] - Status describes the current status of a Namespace. More info

NamespaceCondition

class lightkube.models.core_v1.NamespaceCondition(status, type, lastTransitionTime=None, message=None, reason=None)

NamespaceCondition contains details about state of namespace.

parameters

• status str - Status of the condition, one of True, False, Unknown.
• type str - Type of namespace controller condition.
• lastTransitionTime Optional[meta_v1.Time] - Last time the condition transitioned from one status to another.
• message Optional[str] - Human-readable message indicating details about last transition.
• reason Optional[str] - Unique, one-word, CamelCase reason for the condition's last transition.

NamespaceList

class lightkube.models.core_v1.NamespaceList(items, apiVersion=None, kind=None, metadata=None)

NamespaceList is a list of Namespaces.

parameters

• items List[Namespace] - Items is the list of Namespace objects in the list. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

NamespaceSpec

class lightkube.models.core_v1.NamespaceSpec(finalizers=None)

NamespaceSpec describes the attributes on a Namespace.

parameters

• finalizers Optional[List[str]] - Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info

NamespaceStatus

class lightkube.models.core_v1.NamespaceStatus(conditions=None, phase=None)

NamespaceStatus is information about the current status of a Namespace.

parameters

• conditions Optional[List[NamespaceCondition]] - Represents the latest available observations of a namespace's current state.
• phase Optional[str] - Phase is the current lifecycle phase of the namespace. More info

Node

class lightkube.models.core_v1.Node(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

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

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[NodeSpec] - Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
• status Optional[NodeStatus] - Most recently observed status of the node. Populated by the system. Read-only. More info

NodeAddress

class lightkube.models.core_v1.NodeAddress(address, type)

NodeAddress contains information for the node's address.

parameters

• address str - The node address.
• type str - Node address type, one of Hostname, ExternalIP or InternalIP.

NodeAffinity

class lightkube.models.core_v1.NodeAffinity(preferredDuringSchedulingIgnoredDuringExecution=None, requiredDuringSchedulingIgnoredDuringExecution=None)

Node affinity is a group of node affinity scheduling rules.

parameters

• preferredDuringSchedulingIgnoredDuringExecution Optional[List[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.
• requiredDuringSchedulingIgnoredDuringExecution Optional[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.

NodeCondition

class lightkube.models.core_v1.NodeCondition(status, type, lastHeartbeatTime=None, lastTransitionTime=None, message=None, reason=None)

NodeCondition contains condition information for a node.

parameters

• status str - Status of the condition, one of True, False, Unknown.
• type str - Type of node condition.
• lastHeartbeatTime Optional[meta_v1.Time] - Last time we got an update on a given condition.
• lastTransitionTime Optional[meta_v1.Time] - Last time the condition transit from one status to another.
• message Optional[str] - Human readable message indicating details about last transition.
• reason Optional[str] - (brief) reason for the condition's last transition.

NodeConfigSource

class lightkube.models.core_v1.NodeConfigSource(configMap=None)

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

parameters

• configMap Optional[ConfigMapNodeConfigSource] - ConfigMap is a reference to a Node's ConfigMap

NodeConfigStatus

class lightkube.models.core_v1.NodeConfigStatus(active=None, assigned=None, error=None, lastKnownGood=None)

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

parameters

• active Optional[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.
• assigned Optional[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.
• error Optional[str] - 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.
• lastKnownGood Optional[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.

NodeDaemonEndpoints

class lightkube.models.core_v1.NodeDaemonEndpoints(kubeletEndpoint=None)

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

parameters

• kubeletEndpoint Optional[DaemonEndpoint] - Endpoint on which Kubelet is listening.

NodeFeatures

class lightkube.models.core_v1.NodeFeatures(supplementalGroupsPolicy=None)

NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.

parameters

• supplementalGroupsPolicy Optional[bool] - SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.

NodeList

class lightkube.models.core_v1.NodeList(items, apiVersion=None, kind=None, metadata=None)

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

parameters

• items List[Node] - List of nodes
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

NodeRuntimeHandler

class lightkube.models.core_v1.NodeRuntimeHandler(features=None, name=None)

NodeRuntimeHandler is a set of runtime handler information.

parameters

• features Optional[NodeRuntimeHandlerFeatures] - Supported features.
• name Optional[str] - Runtime handler name. Empty for the default runtime handler.

NodeRuntimeHandlerFeatures

class lightkube.models.core_v1.NodeRuntimeHandlerFeatures(recursiveReadOnlyMounts=None, userNamespaces=None)

NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.

parameters

• recursiveReadOnlyMounts Optional[bool] - RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.
• userNamespaces Optional[bool] - UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.

NodeSelector

class lightkube.models.core_v1.NodeSelector(nodeSelectorTerms)

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.

parameters

• nodeSelectorTerms List[NodeSelectorTerm] - Required. A list of node selector terms. The terms are ORed.

NodeSelectorRequirement

class lightkube.models.core_v1.NodeSelectorRequirement(key, operator, values=None)

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

parameters

• key str - The label key that the selector applies to.
• operator str - Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
• values Optional[List[str]] - 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.

NodeSelectorTerm

class lightkube.models.core_v1.NodeSelectorTerm(matchExpressions=None, matchFields=None)

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.

parameters

• matchExpressions Optional[List[NodeSelectorRequirement]] - A list of node selector requirements by node's labels.
• matchFields Optional[List[NodeSelectorRequirement]] - A list of node selector requirements by node's fields.

NodeSpec

class lightkube.models.core_v1.NodeSpec(configSource=None, externalID=None, podCIDR=None, podCIDRs=None, providerID=None, taints=None, unschedulable=None)

NodeSpec describes the attributes that a node is created with.

parameters

• configSource Optional[NodeConfigSource] - Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed.
• externalID Optional[str] - Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
• podCIDR Optional[str] - PodCIDR represents the pod IP range assigned to the node.
• podCIDRs Optional[List[str]] - podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.
• providerID Optional[str] - ID of the node assigned by the cloud provider in the format: ://
• taints Optional[List[Taint]] - If specified, the node's taints.
• unschedulable Optional[bool] - Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info

NodeStatus

class lightkube.models.core_v1.NodeStatus(addresses=None, allocatable=None, capacity=None, conditions=None, config=None, daemonEndpoints=None, features=None, images=None, nodeInfo=None, phase=None, runtimeHandlers=None, volumesAttached=None, volumesInUse=None)

NodeStatus is information about the current status of a node.

parameters

• addresses Optional[List[NodeAddress]] - List of addresses reachable to the node. Queried from cloud provider, if available. More info Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
• allocatable Optional[dict] - Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
• capacity Optional[dict] - Capacity represents the total resources of a node. More info
• conditions Optional[List[NodeCondition]] - Conditions is an array of current observed node conditions. More info
• config Optional[NodeConfigStatus] - Status of the config assigned to the node via the dynamic Kubelet config feature.
• daemonEndpoints Optional[NodeDaemonEndpoints] - Endpoints of daemons running on the Node.
• features Optional[NodeFeatures] - Features describes the set of features implemented by the CRI implementation.
• images Optional[List[ContainerImage]] - List of container images on this node
• nodeInfo Optional[NodeSystemInfo] - Set of ids/uuids to uniquely identify the node. More info
• phase Optional[str] - NodePhase is the recently observed lifecycle phase of the node. More info The field is never populated, and now is deprecated.
• runtimeHandlers Optional[List[NodeRuntimeHandler]] - The available runtime handlers.
• volumesAttached Optional[List[AttachedVolume]] - List of volumes that are attached to the node.
• volumesInUse Optional[List[str]] - List of attachable volumes in use (mounted) by the node.

NodeSwapStatus

class lightkube.models.core_v1.NodeSwapStatus(capacity=None)

NodeSwapStatus represents swap memory information.

parameters

• capacity Optional[int] - Total amount of swap memory in bytes.

NodeSystemInfo

class lightkube.models.core_v1.NodeSystemInfo(architecture, bootID, containerRuntimeVersion, kernelVersion, kubeProxyVersion, kubeletVersion, machineID, operatingSystem, osImage, systemUUID, swap=None)

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

parameters

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

ObjectFieldSelector

class lightkube.models.core_v1.ObjectFieldSelector(fieldPath, apiVersion=None)

ObjectFieldSelector selects an APIVersioned field of an object.

parameters

• fieldPath str - Path of the field to select in the specified API version.
• apiVersion Optional[str] - Version of the schema the FieldPath is written in terms of, defaults to "v1".

ObjectReference

class lightkube.models.core_v1.ObjectReference(apiVersion=None, fieldPath=None, kind=None, name=None, namespace=None, resourceVersion=None, uid=None)

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

parameters

• apiVersion Optional[str] - API version of the referent.
• fieldPath Optional[str] - If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
• kind Optional[str] - Kind of the referent. More info
• name Optional[str] - Name of the referent. More info
• namespace Optional[str] - Namespace of the referent. More info
• resourceVersion Optional[str] - Specific resourceVersion to which this reference is made, if any. More info
• uid Optional[str] - UID of the referent. More info

PersistentVolume

class lightkube.models.core_v1.PersistentVolume(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[PersistentVolumeSpec] - spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info
• status Optional[PersistentVolumeStatus] - status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info

PersistentVolumeClaim

class lightkube.models.core_v1.PersistentVolumeClaim(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

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

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[PersistentVolumeClaimSpec] - spec defines the desired characteristics of a volume requested by a pod author. More info
• status Optional[PersistentVolumeClaimStatus] - status represents the current information/status of a persistent volume claim. Read-only. More info

PersistentVolumeClaimCondition

class lightkube.models.core_v1.PersistentVolumeClaimCondition(status, type, lastProbeTime=None, lastTransitionTime=None, message=None, reason=None)

PersistentVolumeClaimCondition contains details about state of pvc

parameters

• status str - Status is the status of the condition. Can be True, False, Unknown. More info
• type str - Type is the type of the condition. More info
• lastProbeTime Optional[meta_v1.Time] - lastProbeTime is the time we probed the condition.
• lastTransitionTime Optional[meta_v1.Time] - lastTransitionTime is the time the condition transitioned from one status to another.
• message Optional[str] - message is the human-readable message indicating details about last transition.
• reason Optional[str] - reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.

PersistentVolumeClaimList

class lightkube.models.core_v1.PersistentVolumeClaimList(items, apiVersion=None, kind=None, metadata=None)

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

parameters

• items List[PersistentVolumeClaim] - items is a list of persistent volume claims. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

PersistentVolumeClaimSpec

class lightkube.models.core_v1.PersistentVolumeClaimSpec(accessModes=None, dataSource=None, dataSourceRef=None, resources=None, selector=None, storageClassName=None, volumeAttributesClassName=None, volumeMode=None, volumeName=None)

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

parameters

• accessModes Optional[List[str]] - accessModes contains the desired access modes the volume should have. More info
• dataSource Optional[TypedLocalObjectReference] - dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
• dataSourceRef Optional[TypedObjectReference] - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
• While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
• While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
• resources Optional[VolumeResourceRequirements] - resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info
• selector Optional[meta_v1.LabelSelector] - selector is a label query over volumes to consider for binding.
• storageClassName Optional[str] - storageClassName is the name of the StorageClass required by the claim. More info
• volumeAttributesClassName Optional[str] - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
• volumeMode Optional[str] - volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
• volumeName Optional[str] - volumeName is the binding reference to the PersistentVolume backing this claim.

PersistentVolumeClaimStatus

class lightkube.models.core_v1.PersistentVolumeClaimStatus(accessModes=None, allocatedResourceStatuses=None, allocatedResources=None, capacity=None, conditions=None, currentVolumeAttributesClassName=None, modifyVolumeStatus=None, phase=None)

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

parameters

• accessModes Optional[List[str]] - accessModes contains the actual access modes the volume backing the PVC has. More info
• allocatedResourceStatuses Optional[dict] - allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
  • pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
  • pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
  • pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
  • pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
• allocatedResources Optional[dict] - allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
• capacity Optional[dict] - capacity represents the actual resources of the underlying volume.
• conditions Optional[List[PersistentVolumeClaimCondition]] - conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
• currentVolumeAttributesClassName Optional[str] - currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
• modifyVolumeStatus Optional[ModifyVolumeStatus] - ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
• phase Optional[str] - phase represents the current phase of PersistentVolumeClaim.

PersistentVolumeClaimTemplate

class lightkube.models.core_v1.PersistentVolumeClaimTemplate(spec, metadata=None)

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

parameters

• spec PersistentVolumeClaimSpec - The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
• metadata Optional[meta_v1.ObjectMeta] - May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

PersistentVolumeClaimVolumeSource

class lightkube.models.core_v1.PersistentVolumeClaimVolumeSource(claimName, readOnly=None)

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

parameters

• claimName str - claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info
• readOnly Optional[bool] - readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

PersistentVolumeList

class lightkube.models.core_v1.PersistentVolumeList(items, apiVersion=None, kind=None, metadata=None)

PersistentVolumeList is a list of PersistentVolume items.

parameters

• items List[PersistentVolume] - items is a list of persistent volumes. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

PersistentVolumeSpec

class lightkube.models.core_v1.PersistentVolumeSpec(accessModes=None, awsElasticBlockStore=None, azureDisk=None, azureFile=None, capacity=None, cephfs=None, cinder=None, claimRef=None, csi=None, fc=None, flexVolume=None, flocker=None, gcePersistentDisk=None, glusterfs=None, hostPath=None, iscsi=None, local=None, mountOptions=None, nfs=None, nodeAffinity=None, persistentVolumeReclaimPolicy=None, photonPersistentDisk=None, portworxVolume=None, quobyte=None, rbd=None, scaleIO=None, storageClassName=None, storageos=None, volumeAttributesClassName=None, volumeMode=None, vsphereVolume=None)

PersistentVolumeSpec is the specification of a persistent volume.

parameters

• accessModes Optional[List[str]] - accessModes contains all ways the volume can be mounted. More info
• awsElasticBlockStore Optional[AWSElasticBlockStoreVolumeSource] - awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info
• azureDisk Optional[AzureDiskVolumeSource] - azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
• azureFile Optional[AzureFilePersistentVolumeSource] - azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
• capacity Optional[dict] - capacity is the description of the persistent volume's resources and capacity. More info
• cephfs Optional[CephFSPersistentVolumeSource] - cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
• cinder Optional[CinderPersistentVolumeSource] - cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info
• claimRef Optional[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
• csi Optional[CSIPersistentVolumeSource] - csi represents storage that is handled by an external CSI driver.
• fc Optional[FCVolumeSource] - fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
• flexVolume Optional[FlexPersistentVolumeSource] - flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
• flocker Optional[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. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
• gcePersistentDisk Optional[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. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info
• glusterfs Optional[GlusterfsPersistentVolumeSource] - glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info
• hostPath Optional[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
• iscsi Optional[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.
• local Optional[LocalVolumeSource] - local represents directly-attached storage with node affinity
• mountOptions Optional[List[str]] - mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated
• mount will simply fail if one is invalid. More info
• nfs Optional[NFSVolumeSource] - nfs represents an NFS mount on the host. Provisioned by an admin. More info
• nodeAffinity Optional[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.
• persistentVolumeReclaimPolicy Optional[str] - persistentVolumeReclaimPolicy defines 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
• photonPersistentDisk Optional[PhotonPersistentDiskVolumeSource] - photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
• portworxVolume Optional[PortworxVolumeSource] - portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
• quobyte Optional[QuobyteVolumeSource] - quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
• rbd Optional[RBDPersistentVolumeSource] - rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info
• scaleIO Optional[ScaleIOPersistentVolumeSource] - scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
• storageClassName Optional[str] - storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
• storageos Optional[StorageOSPersistentVolumeSource] - storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info
• volumeAttributesClassName Optional[str] - Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
• volumeMode Optional[str] - 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.
• vsphereVolume Optional[VsphereVirtualDiskVolumeSource] - vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.

PersistentVolumeStatus

class lightkube.models.core_v1.PersistentVolumeStatus(lastPhaseTransitionTime=None, message=None, phase=None, reason=None)

PersistentVolumeStatus is the current status of a persistent volume.

parameters

• lastPhaseTransitionTime Optional[meta_v1.Time] - lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions.
• message Optional[str] - message is a human-readable message indicating details about why the volume is in this state.
• phase Optional[str] - phase indicates if a volume is available, bound to a claim, or released by a claim. More info
• reason Optional[str] - reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

PhotonPersistentDiskVolumeSource

class lightkube.models.core_v1.PhotonPersistentDiskVolumeSource(pdID, fsType=None)

Represents a Photon Controller persistent disk resource.

parameters

• pdID str - pdID is the ID that identifies Photon Controller persistent disk
• fsType Optional[str] - fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

Pod

class lightkube.models.core_v1.Pod(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

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

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[PodSpec] - Specification of the desired behavior of the pod. More info
• status Optional[PodStatus] - Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info

PodAffinity

class lightkube.models.core_v1.PodAffinity(preferredDuringSchedulingIgnoredDuringExecution=None, requiredDuringSchedulingIgnoredDuringExecution=None)

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

parameters

• preferredDuringSchedulingIgnoredDuringExecution Optional[List[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.
• requiredDuringSchedulingIgnoredDuringExecution Optional[List[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.

PodAffinityTerm

class lightkube.models.core_v1.PodAffinityTerm(topologyKey, labelSelector=None, matchLabelKeys=None, mismatchLabelKeys=None, namespaceSelector=None, namespaces=None)

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

parameters

• topologyKey str - 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.
• labelSelector Optional[meta_v1.LabelSelector] - A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
• matchLabelKeys Optional[List[str]] - MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key in (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
• mismatchLabelKeys Optional[List[str]] - MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with labelSelector as key notin (value) to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
• namespaceSelector Optional[meta_v1.LabelSelector] - A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
• namespaces Optional[List[str]] - namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".

PodAntiAffinity

class lightkube.models.core_v1.PodAntiAffinity(preferredDuringSchedulingIgnoredDuringExecution=None, requiredDuringSchedulingIgnoredDuringExecution=None)

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

parameters

• preferredDuringSchedulingIgnoredDuringExecution Optional[List[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.
• requiredDuringSchedulingIgnoredDuringExecution Optional[List[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.

PodCondition

class lightkube.models.core_v1.PodCondition(status, type, lastProbeTime=None, lastTransitionTime=None, message=None, observedGeneration=None, reason=None)

PodCondition contains details for the current condition of this pod.

parameters

• status str - Status is the status of the condition. Can be True, False, Unknown. More info
• type str - Type is the type of the condition. More info
• lastProbeTime Optional[meta_v1.Time] - Last time we probed the condition.
• lastTransitionTime Optional[meta_v1.Time] - Last time the condition transitioned from one status to another.
• message Optional[str] - Human-readable message indicating details about last transition.
• observedGeneration Optional[int] - If set, this represents the .metadata.generation that the pod condition was set based upon. This is an alpha field. Enable PodObservedGenerationTracking to be able to use this field.
• reason Optional[str] - Unique, one-word, CamelCase reason for the condition's last transition.

PodDNSConfig

class lightkube.models.core_v1.PodDNSConfig(nameservers=None, options=None, searches=None)

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

parameters

• nameservers Optional[List[str]] - A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
• options Optional[List[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.
• searches Optional[List[str]] - 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.

PodDNSConfigOption

class lightkube.models.core_v1.PodDNSConfigOption(name=None, value=None)

PodDNSConfigOption defines DNS resolver options of a pod.

parameters

• name Optional[str] - Name is this DNS resolver option's name. Required.
• value Optional[str] - Value is this DNS resolver option's value.

PodIP

class lightkube.models.core_v1.PodIP(ip)

PodIP represents a single IP address allocated to the pod.

parameters

• ip str - IP is the IP address assigned to the pod

PodList

class lightkube.models.core_v1.PodList(items, apiVersion=None, kind=None, metadata=None)

PodList is a list of Pods.

parameters

• items List[Pod] - List of pods. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

PodOS

class lightkube.models.core_v1.PodOS(name)

PodOS defines the OS parameters of a pod.

parameters

• name str - Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null

PodReadinessGate

class lightkube.models.core_v1.PodReadinessGate(conditionType)

PodReadinessGate contains the reference to a pod condition

parameters

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

PodResourceClaim

class lightkube.models.core_v1.PodResourceClaim(name, resourceClaimName=None, resourceClaimTemplateName=None)

PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.

It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.

parameters

• name str - Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.
• resourceClaimName Optional[str] - ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
• resourceClaimTemplateName Optional[str] - ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.

PodResourceClaimStatus

class lightkube.models.core_v1.PodResourceClaimStatus(name, resourceClaimName=None)

PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate. It stores the generated name for the corresponding ResourceClaim.

parameters

• name str - Name uniquely identifies this resource claim inside the pod. This must match the name of an entry in pod.spec.resourceClaims, which implies that the string must be a DNS_LABEL.
• resourceClaimName Optional[str] - ResourceClaimName is the name of the ResourceClaim that was generated for the Pod in the namespace of the Pod. If this is unset, then generating a ResourceClaim was not necessary. The pod.spec.resourceClaims entry can be ignored in this case.

PodSchedulingGate

class lightkube.models.core_v1.PodSchedulingGate(name)

PodSchedulingGate is associated to a Pod to guard its scheduling.

parameters

• name str - Name of the scheduling gate. Each scheduling gate must have a unique name field.

PodSecurityContext

class lightkube.models.core_v1.PodSecurityContext(appArmorProfile=None, fsGroup=None, fsGroupChangePolicy=None, runAsGroup=None, runAsNonRoot=None, runAsUser=None, seLinuxChangePolicy=None, seLinuxOptions=None, seccompProfile=None, supplementalGroups=None, supplementalGroupsPolicy=None, sysctls=None, windowsOptions=None)

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.

parameters

• appArmorProfile Optional[AppArmorProfile] - appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
• fsGroup Optional[int] - A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
• The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
• fsGroupChangePolicy Optional[str] - fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.
• runAsGroup Optional[int] - The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
• runAsNonRoot Optional[bool] - Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
• runAsUser Optional[int] - The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
• seLinuxChangePolicy Optional[str] - seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive". "Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node. "MountOption" mounts all eligible Pod volumes with -o context mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled. If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
• seLinuxOptions Optional[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. Note that this field cannot be set when spec.os.name is windows.
• seccompProfile Optional[SeccompProfile] - The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
• supplementalGroups Optional[List[int]] - A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.
• supplementalGroupsPolicy Optional[str] - Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.
• sysctls Optional[List[Sysctl]] - Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
• windowsOptions Optional[WindowsSecurityContextOptions] - The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

PodSpec

class lightkube.models.core_v1.PodSpec(containers, activeDeadlineSeconds=None, affinity=None, automountServiceAccountToken=None, dnsConfig=None, dnsPolicy=None, enableServiceLinks=None, ephemeralContainers=None, hostAliases=None, hostIPC=None, hostNetwork=None, hostPID=None, hostUsers=None, hostname=None, imagePullSecrets=None, initContainers=None, nodeName=None, nodeSelector=None, os=None, overhead=None, preemptionPolicy=None, priority=None, priorityClassName=None, readinessGates=None, resourceClaims=None, resources=None, restartPolicy=None, runtimeClassName=None, schedulerName=None, schedulingGates=None, securityContext=None, serviceAccount=None, serviceAccountName=None, setHostnameAsFQDN=None, shareProcessNamespace=None, subdomain=None, terminationGracePeriodSeconds=None, tolerations=None, topologySpreadConstraints=None, volumes=None)

PodSpec is a description of a pod.

parameters

• containers List[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.
• activeDeadlineSeconds Optional[int] - 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.
• affinity Optional[Affinity] - If specified, the pod's scheduling constraints
• automountServiceAccountToken Optional[bool] - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
• dnsConfig Optional[PodDNSConfig] - Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
• dnsPolicy Optional[str] - Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
• enableServiceLinks Optional[bool] - EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
• ephemeralContainers Optional[List[EphemeralContainer]] - List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.
• hostAliases Optional[List[HostAlias]] - HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.
• hostIPC Optional[bool] - Use the host's ipc namespace. Optional: Default to false.
• hostNetwork Optional[bool] - Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
• hostPID Optional[bool] - Use the host's pid namespace. Optional: Default to false.
• hostUsers Optional[bool] - Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.
• hostname Optional[str] - Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
• imagePullSecrets Optional[List[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. More info
• initContainers Optional[List[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, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of 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
• nodeName Optional[str] - NodeName indicates in which node this pod is scheduled. If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName. Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod. This field should not be used to express a desire for the pod to be scheduled on a specific node. https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename
• nodeSelector Optional[dict] - 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
• os Optional[PodOS] - Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.securityContext.supplementalGroupsPolicy - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup
• overhead Optional[dict] - Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info
• preemptionPolicy Optional[str] - PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
• priority Optional[int] - The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
• priorityClassName Optional[str] - If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
• readinessGates Optional[List[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
• resourceClaims Optional[List[PodResourceClaim]] - ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable.
• resources Optional[ResourceRequirements] - Resources is the total amount of CPU and Memory resources required by all containers in the pod. It supports specifying Requests and Limits for "cpu" and "memory" resource names only. ResourceClaims are not supported. This field enables fine-grained control over resource allocation for the entire pod, allowing resource sharing among containers in a pod. This is an alpha field and requires enabling the PodLevelResources feature gate.
• restartPolicy Optional[str] - Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info
• runtimeClassName Optional[str] - 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
• schedulerName Optional[str] - If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
• schedulingGates Optional[List[PodSchedulingGate]] - SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. SchedulingGates can only be set at pod creation time, and be removed only afterwards.
• securityContext Optional[PodSecurityContext] - SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
• serviceAccount Optional[str] - DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
• serviceAccountName Optional[str] - ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info
• setHostnameAsFQDN Optional[bool] - If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
• shareProcessNamespace Optional[bool] - Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
• subdomain Optional[str] - If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.
• terminationGracePeriodSeconds Optional[int] - 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 stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
• tolerations Optional[List[Toleration]] - If specified, the pod's tolerations.
• topologySpreadConstraints Optional[List[TopologySpreadConstraint]] - TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
• volumes Optional[List[Volume]] - List of volumes that can be mounted by containers belonging to the pod. More info

PodStatus

class lightkube.models.core_v1.PodStatus(conditions=None, containerStatuses=None, ephemeralContainerStatuses=None, hostIP=None, hostIPs=None, initContainerStatuses=None, message=None, nominatedNodeName=None, observedGeneration=None, phase=None, podIP=None, podIPs=None, qosClass=None, reason=None, resize=None, resourceClaimStatuses=None, startTime=None)

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.

parameters

• conditions Optional[List[PodCondition]] - Current service state of pod. More info
• containerStatuses Optional[List[ContainerStatus]] - Statuses of containers in this pod. Each container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info
• ephemeralContainerStatuses Optional[List[ContainerStatus]] - Statuses for any ephemeral containers that have run in this pod. Each ephemeral container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info
• hostIP Optional[str] - hostIP holds the IP address of the host to which the pod is assigned. Empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will not be updated even if there is a node is assigned to pod
• hostIPs Optional[List[HostIP]] - hostIPs holds the IP addresses allocated to the host. If this field is specified, the first entry must match the hostIP field. This list is empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will not be updated even if there is a node is assigned to this pod.
• initContainerStatuses Optional[List[ContainerStatus]] - Statuses of init containers in this pod. The most recent successful non-restartable init container will have ready = true, the most recently started container will have startTime set. Each init container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info
• message Optional[str] - A human readable message indicating details about why the pod is in this condition.
• nominatedNodeName Optional[str] - 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.
• observedGeneration Optional[int] - If set, this represents the .metadata.generation that the pod status was set based upon. This is an alpha field. Enable PodObservedGenerationTracking to be able to use this field.
• phase Optional[str] - 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
• podIP Optional[str] - podIP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
• podIPs Optional[List[PodIP]] - podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.
• qosClass Optional[str] - The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info
• reason Optional[str] - A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'
• resize Optional[str] - Status of resources resize desired for pod's containers. It is empty if no resources resize is pending. Any changes to container resources will automatically set this to "Proposed" Deprecated: Resize status is moved to two pod conditions PodResizePending and PodResizeInProgress. PodResizePending will track states where the spec has been resized, but the Kubelet has not yet allocated the resources. PodResizeInProgress will track in-progress resizes, and should be present whenever allocated resources != acknowledged resources.
• resourceClaimStatuses Optional[List[PodResourceClaimStatus]] - Status of resource claims.
• startTime Optional[meta_v1.Time] - 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.

PodTemplate

class lightkube.models.core_v1.PodTemplate(apiVersion=None, kind=None, metadata=None, template=None)

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

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• template Optional[PodTemplateSpec] - Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

PodTemplateList

class lightkube.models.core_v1.PodTemplateList(items, apiVersion=None, kind=None, metadata=None)

PodTemplateList is a list of PodTemplates.

parameters

• items List[PodTemplate] - List of pod templates
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

PodTemplateSpec

class lightkube.models.core_v1.PodTemplateSpec(metadata=None, spec=None)

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

parameters

• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[PodSpec] - Specification of the desired behavior of the pod. More info

PortStatus

class lightkube.models.core_v1.PortStatus(port, protocol, error=None)

PortStatus represents the error condition of a service port

parameters

• port int - Port is the port number of the service port of which status is recorded here
• protocol str - Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
• error Optional[str] - Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names
• cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.

PortworxVolumeSource

class lightkube.models.core_v1.PortworxVolumeSource(volumeID, fsType=None, readOnly=None)

PortworxVolumeSource represents a Portworx volume resource.

parameters

• volumeID str - volumeID uniquely identifies a Portworx volume
• fsType Optional[str] - fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
• readOnly Optional[bool] - readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

PreferredSchedulingTerm

class lightkube.models.core_v1.PreferredSchedulingTerm(preference, weight)

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

parameters

• preference NodeSelectorTerm - A node selector term, associated with the corresponding weight.
• weight int - Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

Probe

class lightkube.models.core_v1.Probe(exec=None, failureThreshold=None, grpc=None, httpGet=None, initialDelaySeconds=None, periodSeconds=None, successThreshold=None, tcpSocket=None, terminationGracePeriodSeconds=None, timeoutSeconds=None)

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

parameters

• exec Optional[ExecAction] - Exec specifies a command to execute in the container.
• failureThreshold Optional[int] - Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
• grpc Optional[GRPCAction] - GRPC specifies a GRPC HealthCheckRequest.
• httpGet Optional[HTTPGetAction] - HTTPGet specifies an HTTP GET request to perform.
• initialDelaySeconds Optional[int] - Number of seconds after the container has started before liveness probes are initiated. More info
• periodSeconds Optional[int] - How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
• successThreshold Optional[int] - Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
• tcpSocket Optional[TCPSocketAction] - TCPSocket specifies a connection to a TCP port.
• terminationGracePeriodSeconds Optional[int] - Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
• timeoutSeconds Optional[int] - Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info

ProjectedVolumeSource

class lightkube.models.core_v1.ProjectedVolumeSource(defaultMode=None, sources=None)

Represents a projected volume source

parameters

• defaultMode Optional[int] - defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
• sources Optional[List[VolumeProjection]] - sources is the list of volume projections. Each entry in this list handles one source.

QuobyteVolumeSource

class lightkube.models.core_v1.QuobyteVolumeSource(registry, volume, group=None, readOnly=None, tenant=None, user=None)

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

parameters

• registry str - 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
• volume str - volume is a string that references an already created Quobyte volume by name.
• group Optional[str] - group to map volume access to Default is no group
• readOnly Optional[bool] - readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
• tenant Optional[str] - tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
• user Optional[str] - user to map volume access to Defaults to serivceaccount user

RBDPersistentVolumeSource

class lightkube.models.core_v1.RBDPersistentVolumeSource(image, monitors, fsType=None, keyring=None, pool=None, readOnly=None, secretRef=None, user=None)

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

parameters

• image str - image is the rados image name. More info
• monitors List[str] - monitors is a collection of Ceph monitors. More info
• fsType Optional[str] - fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• keyring Optional[str] - keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info
• pool Optional[str] - pool is the rados pool name. Default is rbd. More info
• readOnly Optional[bool] - readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info
• secretRef Optional[SecretReference] - secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info
• user Optional[str] - user is the rados user name. Default is admin. More info

RBDVolumeSource

class lightkube.models.core_v1.RBDVolumeSource(image, monitors, fsType=None, keyring=None, pool=None, readOnly=None, secretRef=None, user=None)

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

parameters

• image str - image is the rados image name. More info
• monitors List[str] - monitors is a collection of Ceph monitors. More info
• fsType Optional[str] - fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info
• keyring Optional[str] - keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info
• pool Optional[str] - pool is the rados pool name. Default is rbd. More info
• readOnly Optional[bool] - readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info
• secretRef Optional[LocalObjectReference] - secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info
• user Optional[str] - user is the rados user name. Default is admin. More info

ReplicationController

class lightkube.models.core_v1.ReplicationController(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

ReplicationController represents the configuration of a replication controller.

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.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
• spec Optional[ReplicationControllerSpec] - Spec defines the specification of the desired behavior of the replication controller. More info
• status Optional[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

ReplicationControllerCondition

class lightkube.models.core_v1.ReplicationControllerCondition(status, type, lastTransitionTime=None, message=None, reason=None)

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

parameters

• status str - Status of the condition, one of True, False, Unknown.
• type str - Type of replication controller condition.
• lastTransitionTime Optional[meta_v1.Time] - The last time the condition transitioned from one status to another.
• message Optional[str] - A human readable message indicating details about the transition.
• reason Optional[str] - The reason for the condition's last transition.

ReplicationControllerList

class lightkube.models.core_v1.ReplicationControllerList(items, apiVersion=None, kind=None, metadata=None)

ReplicationControllerList is a collection of replication controllers.

parameters

• items List[ReplicationController] - List of replication controllers. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

ReplicationControllerSpec

class lightkube.models.core_v1.ReplicationControllerSpec(minReadySeconds=None, replicas=None, selector=None, template=None)

ReplicationControllerSpec is the specification of a replication controller.

parameters

• minReadySeconds Optional[int] - Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
• replicas Optional[int] - Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info
• selector Optional[dict] - 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
• template Optional[PodTemplateSpec] - Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. The only allowed template.spec.restartPolicy value is "Always". More info

ReplicationControllerStatus

class lightkube.models.core_v1.ReplicationControllerStatus(replicas, availableReplicas=None, conditions=None, fullyLabeledReplicas=None, observedGeneration=None, readyReplicas=None)

ReplicationControllerStatus represents the current status of a replication controller.

parameters

• replicas int - Replicas is the most recently observed number of replicas. More info
• availableReplicas Optional[int] - The number of available replicas (ready for at least minReadySeconds) for this replication controller.
• conditions Optional[List[ReplicationControllerCondition]] - Represents the latest available observations of a replication controller's current state.
• fullyLabeledReplicas Optional[int] - The number of pods that have labels matching the labels of the pod template of the replication controller.
• observedGeneration Optional[int] - ObservedGeneration reflects the generation of the most recently observed replication controller.
• readyReplicas Optional[int] - The number of ready replicas for this replication controller.

ResourceClaim

class lightkube.models.core_v1.ResourceClaim(name, request=None)

ResourceClaim references one entry in PodSpec.ResourceClaims.

parameters

• name str - Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
• request Optional[str] - Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

ResourceFieldSelector

class lightkube.models.core_v1.ResourceFieldSelector(resource, containerName=None, divisor=None)

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

parameters

• resource str - Required: resource to select
• containerName Optional[str] - Container name: required for volumes, optional for env vars
• divisor Optional[resource.Quantity] - Specifies the output format of the exposed resources, defaults to "1"

ResourceHealth

class lightkube.models.core_v1.ResourceHealth(resourceID, health=None)

ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.

parameters

• resourceID str - ResourceID is the unique identifier of the resource. See the ResourceID type for more information.
• health Optional[str] - Health of the resource. can be one of:
• Healthy: operates as normal
• Unhealthy: reported unhealthy. We consider this a temporary health issue since we do not have a mechanism today to distinguish temporary and permanent issues.
• Unknown: The status cannot be determined. For example, Device Plugin got unregistered and hasn't been re-registered since. In future we may want to introduce the PermanentlyUnhealthy Status.

ResourceQuota

class lightkube.models.core_v1.ResourceQuota(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

ResourceQuota sets aggregate quota restrictions enforced per namespace

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[ResourceQuotaSpec] - Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
• status Optional[ResourceQuotaStatus] - Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

ResourceQuotaList

class lightkube.models.core_v1.ResourceQuotaList(items, apiVersion=None, kind=None, metadata=None)

ResourceQuotaList is a list of ResourceQuota items.

parameters

• items List[ResourceQuota] - Items is a list of ResourceQuota objects. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

ResourceQuotaSpec

class lightkube.models.core_v1.ResourceQuotaSpec(hard=None, scopeSelector=None, scopes=None)

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

parameters

• hard Optional[dict] - hard is the set of desired hard limits for each named resource. More info
• scopeSelector Optional[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.
• scopes Optional[List[str]] - A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

ResourceQuotaStatus

class lightkube.models.core_v1.ResourceQuotaStatus(hard=None, used=None)

ResourceQuotaStatus defines the enforced hard limits and observed use.

parameters

• hard Optional[dict] - Hard is the set of enforced hard limits for each named resource. More info
• used Optional[dict] - Used is the current observed total usage of the resource in the namespace.

ResourceRequirements

class lightkube.models.core_v1.ResourceRequirements(claims=None, limits=None, requests=None)

ResourceRequirements describes the compute resource requirements.

parameters

• claims Optional[List[ResourceClaim]] - Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
• limits Optional[dict] - Limits describes the maximum amount of compute resources allowed. More info
• requests Optional[dict] - Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info

ResourceStatus

class lightkube.models.core_v1.ResourceStatus(name, resources=None)

ResourceStatus represents the status of a single resource allocated to a Pod.

parameters

• name str - Name of the resource. Must be unique within the pod and in case of non-DRA resource, match one of the resources from the pod spec. For DRA resources, the value must be "claim:/". When this status is reported about a container, the "claim_name" and "request" must match one of the claims of this container.
• resources Optional[List[ResourceHealth]] - List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node. If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share. See ResourceID type definition for a specific format it has in various use cases.

SELinuxOptions

class lightkube.models.core_v1.SELinuxOptions(level=None, role=None, type=None, user=None)

SELinuxOptions are the labels to be applied to the container

parameters

• level Optional[str] - Level is SELinux level label that applies to the container.
• role Optional[str] - Role is a SELinux role label that applies to the container.
• type Optional[str] - Type is a SELinux type label that applies to the container.
• user Optional[str] - User is a SELinux user label that applies to the container.

ScaleIOPersistentVolumeSource

class lightkube.models.core_v1.ScaleIOPersistentVolumeSource(gateway, secretRef, system, fsType=None, protectionDomain=None, readOnly=None, sslEnabled=None, storageMode=None, storagePool=None, volumeName=None)

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

parameters

• gateway str - gateway is the host address of the ScaleIO API Gateway.
• secretRef SecretReference - secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
• system str - system is the name of the storage system as configured in ScaleIO.
• fsType Optional[str] - fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
• protectionDomain Optional[str] - protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
• readOnly Optional[bool] - readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
• sslEnabled Optional[bool] - sslEnabled is the flag to enable/disable SSL communication with Gateway, default false
• storageMode Optional[str] - storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
• storagePool Optional[str] - storagePool is the ScaleIO Storage Pool associated with the protection domain.
• volumeName Optional[str] - volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

ScaleIOVolumeSource

class lightkube.models.core_v1.ScaleIOVolumeSource(gateway, secretRef, system, fsType=None, protectionDomain=None, readOnly=None, sslEnabled=None, storageMode=None, storagePool=None, volumeName=None)

ScaleIOVolumeSource represents a persistent ScaleIO volume

parameters

• gateway str - gateway is the host address of the ScaleIO API Gateway.
• secretRef LocalObjectReference - secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
• system str - system is the name of the storage system as configured in ScaleIO.
• fsType Optional[str] - fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
• protectionDomain Optional[str] - protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
• readOnly Optional[bool] - readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
• sslEnabled Optional[bool] - sslEnabled Flag enable/disable SSL communication with Gateway, default false
• storageMode Optional[str] - storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
• storagePool Optional[str] - storagePool is the ScaleIO Storage Pool associated with the protection domain.
• volumeName Optional[str] - volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

ScopeSelector

class lightkube.models.core_v1.ScopeSelector(matchExpressions=None)

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

parameters

• matchExpressions Optional[List[ScopedResourceSelectorRequirement]] - A list of scope selector requirements by scope of the resources.

ScopedResourceSelectorRequirement

class lightkube.models.core_v1.ScopedResourceSelectorRequirement(operator, scopeName, values=None)

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

parameters

• operator str - Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
• scopeName str - The name of the scope that the selector applies to.
• values Optional[List[str]] - 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.

SeccompProfile

class lightkube.models.core_v1.SeccompProfile(type, localhostProfile=None)

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

parameters

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

Secret

class lightkube.models.core_v1.Secret(apiVersion=None, data=None, immutable=None, kind=None, metadata=None, stringData=None, type=None)

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

parameters

• apiVersion Optional[str] - 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
• data Optional[dict] - Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
• immutable Optional[bool] - Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• stringData Optional[dict] - stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
• type Optional[str] - Used to facilitate programmatic handling of secret data. More info

SecretEnvSource

class lightkube.models.core_v1.SecretEnvSource(name=None, optional=None)

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.

parameters

• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info
• optional Optional[bool] - Specify whether the Secret must be defined

SecretKeySelector

class lightkube.models.core_v1.SecretKeySelector(key, name=None, optional=None)

SecretKeySelector selects a key of a Secret.

parameters

• key str - The key of the secret to select from. Must be a valid secret key.
• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info
• optional Optional[bool] - Specify whether the Secret or its key must be defined

SecretList

class lightkube.models.core_v1.SecretList(items, apiVersion=None, kind=None, metadata=None)

SecretList is a list of Secret.

parameters

• items List[Secret] - Items is a list of secret objects. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

SecretProjection

class lightkube.models.core_v1.SecretProjection(items=None, name=None, optional=None)

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.

parameters

• items Optional[List[KeyToPath]] - items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
• name Optional[str] - Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info
• optional Optional[bool] - optional field specify whether the Secret or its key must be defined

SecretReference

class lightkube.models.core_v1.SecretReference(name=None, namespace=None)

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

parameters

• name Optional[str] - name is unique within a namespace to reference a secret resource.
• namespace Optional[str] - namespace defines the space within which the secret name must be unique.

SecretVolumeSource

class lightkube.models.core_v1.SecretVolumeSource(defaultMode=None, items=None, optional=None, secretName=None)

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.

parameters

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

SecurityContext

class lightkube.models.core_v1.SecurityContext(allowPrivilegeEscalation=None, appArmorProfile=None, capabilities=None, privileged=None, procMount=None, readOnlyRootFilesystem=None, runAsGroup=None, runAsNonRoot=None, runAsUser=None, seLinuxOptions=None, seccompProfile=None, windowsOptions=None)

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.

parameters

• allowPrivilegeEscalation Optional[bool] - AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
• appArmorProfile Optional[AppArmorProfile] - appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
• capabilities Optional[Capabilities] - The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
• privileged Optional[bool] - Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
• procMount Optional[str] - procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
• readOnlyRootFilesystem Optional[bool] - Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
• runAsGroup Optional[int] - The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
• runAsNonRoot Optional[bool] - Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
• runAsUser Optional[int] - The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
• seLinuxOptions Optional[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. Note that this field cannot be set when spec.os.name is windows.
• seccompProfile Optional[SeccompProfile] - The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
• windowsOptions Optional[WindowsSecurityContextOptions] - The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Service

class lightkube.models.core_v1.Service(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

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.

parameters

• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• spec Optional[ServiceSpec] - Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
• status Optional[ServiceStatus] - Most recently observed status of the service. Populated by the system. Read-only. More info

ServiceAccount

class lightkube.models.core_v1.ServiceAccount(apiVersion=None, automountServiceAccountToken=None, imagePullSecrets=None, kind=None, metadata=None, secrets=None)

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

parameters

• apiVersion Optional[str] - 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
• automountServiceAccountToken Optional[bool] - AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
• imagePullSecrets Optional[List[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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ObjectMeta] - Standard object's metadata. More info
• secrets Optional[List[ObjectReference]] - Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". The "kubernetes.io/enforce-mountable-secrets" annotation is deprecated since v1.32. Prefer separate namespaces to isolate access to mounted secrets. This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info

ServiceAccountList

class lightkube.models.core_v1.ServiceAccountList(items, apiVersion=None, kind=None, metadata=None)

ServiceAccountList is a list of ServiceAccount objects

parameters

• items List[ServiceAccount] - List of ServiceAccounts. More info
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

ServiceAccountTokenProjection

class lightkube.models.core_v1.ServiceAccountTokenProjection(path, audience=None, expirationSeconds=None)

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

parameters

• path str - path is the path relative to the mount point of the file to project the token into.
• audience Optional[str] - audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
• expirationSeconds Optional[int] - 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.

ServiceList

class lightkube.models.core_v1.ServiceList(items, apiVersion=None, kind=None, metadata=None)

ServiceList holds a list of services.

parameters

• items List[Service] - List of services
• apiVersion Optional[str] - 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
• kind Optional[str] - 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
• metadata Optional[meta_v1.ListMeta] - Standard list metadata. More info

ServicePort

class lightkube.models.core_v1.ServicePort(port, appProtocol=None, name=None, nodePort=None, protocol=None, targetPort=None)

ServicePort contains information on service's port.

parameters

• port int - The port that will be exposed by this service.
• appProtocol Optional[str] - The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
• Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
• Kubernetes-defined prefixed names:
  • 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
  • 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
  • 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
• Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
• name Optional[str] - The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
• nodePort Optional[int] - The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info
• protocol Optional[str] - The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
• targetPort Optional[util_intstr.IntOrString] - 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

ServiceSpec

class lightkube.models.core_v1.ServiceSpec(allocateLoadBalancerNodePorts=None, clusterIP=None, clusterIPs=None, externalIPs=None, externalName=None, externalTrafficPolicy=None, healthCheckNodePort=None, internalTrafficPolicy=None, ipFamilies=None, ipFamilyPolicy=None, loadBalancerClass=None, loadBalancerIP=None, loadBalancerSourceRanges=None, ports=None, publishNotReadyAddresses=None, selector=None, sessionAffinity=None, sessionAffinityConfig=None, trafficDistribution=None, type=None)

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

parameters

• allocateLoadBalancerNodePorts Optional[bool] - allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type.
• clusterIP Optional[str] - clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info
• clusterIPs Optional[List[str]] - ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. This field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info
• externalIPs Optional[List[str]] - externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.
• externalName Optional[str] - externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires type to be "ExternalName".
• externalTrafficPolicy Optional[str] - externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.
• healthCheckNodePort Optional[int] - healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set.
• internalTrafficPolicy Optional[str] - InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features).
• ipFamilies Optional[List[str]] - IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
• ipFamilyPolicy Optional[str] - IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName.
• loadBalancerClass Optional[str] - loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
• loadBalancerIP Optional[str] - Only applies to Service Type: LoadBalancer. 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. Deprecated: This field was under-specified and its meaning varies across implementations. Using it is non-portable and it may not support dual-stack. Users are encouraged to use implementation-specific annotations when available.
• loadBalancerSourceRanges Optional[List[str]] - 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
• ports Optional[List[ServicePort]] - The list of ports that are exposed by this service. More info
• publishNotReadyAddresses Optional[bool] - publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior.
• selector Optional[dict] - 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
• sessionAffinity Optional[str] - 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
• sessionAffinityConfig Optional[SessionAffinityConfig] - sessionAffinityConfig contains the configurations of session affinity.
• trafficDistribution Optional[str] - TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to "PreferClose", implementations should prioritize endpoints that are in the same zone.
• type Optional[str] - type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info

ServiceStatus

class lightkube.models.core_v1.ServiceStatus(conditions=None, loadBalancer=None)

ServiceStatus represents the current status of a service.

parameters

• conditions Optional[List[meta_v1.Condition]] - Current service state
• loadBalancer Optional[LoadBalancerStatus] - LoadBalancer contains the current status of the load-balancer, if one is present.

SessionAffinityConfig

class lightkube.models.core_v1.SessionAffinityConfig(clientIP=None)

SessionAffinityConfig represents the configurations of session affinity.

parameters

• clientIP Optional[ClientIPConfig] - clientIP contains the configurations of Client IP based session affinity.

SleepAction

class lightkube.models.core_v1.SleepAction(seconds)

SleepAction describes a "sleep" action.

parameters

• seconds int - Seconds is the number of seconds to sleep.

StorageOSPersistentVolumeSource

class lightkube.models.core_v1.StorageOSPersistentVolumeSource(fsType=None, readOnly=None, secretRef=None, volumeName=None, volumeNamespace=None)

Represents a StorageOS persistent volume resource.

parameters

• fsType Optional[str] - fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
• readOnly Optional[bool] - readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
• secretRef Optional[ObjectReference] - secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
• volumeName Optional[str] - volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
• volumeNamespace Optional[str] - 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.

StorageOSVolumeSource

class lightkube.models.core_v1.StorageOSVolumeSource(fsType=None, readOnly=None, secretRef=None, volumeName=None, volumeNamespace=None)

Represents a StorageOS persistent volume resource.

parameters

• fsType Optional[str] - fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
• readOnly Optional[bool] - readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
• secretRef Optional[LocalObjectReference] - secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
• volumeName Optional[str] - volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
• volumeNamespace Optional[str] - 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.

Sysctl

class lightkube.models.core_v1.Sysctl(name, value)

Sysctl defines a kernel parameter to be set

parameters

• name str - Name of a property to set
• value str - Value of a property to set

TCPSocketAction

class lightkube.models.core_v1.TCPSocketAction(port, host=None)

TCPSocketAction describes an action based on opening a socket

parameters

• port util_intstr.IntOrString - 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.
• host Optional[str] - Optional: Host name to connect to, defaults to the pod IP.

Taint

class lightkube.models.core_v1.Taint(effect, key, timeAdded=None, value=None)

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

parameters

• effect str - Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
• key str - Required. The taint key to be applied to a node.
• timeAdded Optional[meta_v1.Time] - TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
• value Optional[str] - The taint value corresponding to the taint key.

Toleration

class lightkube.models.core_v1.Toleration(effect=None, key=None, operator=None, tolerationSeconds=None, value=None)

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

parameters

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

TopologySelectorLabelRequirement

class lightkube.models.core_v1.TopologySelectorLabelRequirement(key, values)

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

parameters

• key str - The label key that the selector applies to.
• values List[str] - An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

TopologySelectorTerm

class lightkube.models.core_v1.TopologySelectorTerm(matchLabelExpressions=None)

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.

parameters

• matchLabelExpressions Optional[List[TopologySelectorLabelRequirement]] - A list of topology selector requirements by labels.

TopologySpreadConstraint

class lightkube.models.core_v1.TopologySpreadConstraint(maxSkew, topologyKey, whenUnsatisfiable, labelSelector=None, matchLabelKeys=None, minDomains=None, nodeAffinityPolicy=None, nodeTaintsPolicy=None)

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

parameters

• maxSkew int - MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.
• topologyKey str - TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field.
• whenUnsatisfiable str - WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.
• labelSelector Optional[meta_v1.LabelSelector] - LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
• matchLabelKeys Optional[List[str]] - MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
• minDomains Optional[int] - MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.
• nodeAffinityPolicy Optional[str] - NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy.
• nodeTaintsPolicy Optional[str] - NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy.

TypedLocalObjectReference

class lightkube.models.core_v1.TypedLocalObjectReference(kind, name, apiGroup=None)

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

parameters

• kind str - Kind is the type of resource being referenced
• name str - Name is the name of resource being referenced
• apiGroup Optional[str] - 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.

TypedObjectReference

class lightkube.models.core_v1.TypedObjectReference(kind, name, apiGroup=None, namespace=None)

TypedObjectReference contains enough information to let you locate the typed referenced object

parameters

• kind str - Kind is the type of resource being referenced
• name str - Name is the name of resource being referenced
• apiGroup Optional[str] - 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.
• namespace Optional[str] - Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

Volume

class lightkube.models.core_v1.Volume(name, awsElasticBlockStore=None, azureDisk=None, azureFile=None, cephfs=None, cinder=None, configMap=None, csi=None, downwardAPI=None, emptyDir=None, ephemeral=None, fc=None, flexVolume=None, flocker=None, gcePersistentDisk=None, gitRepo=None, glusterfs=None, hostPath=None, image=None, iscsi=None, nfs=None, persistentVolumeClaim=None, photonPersistentDisk=None, portworxVolume=None, projected=None, quobyte=None, rbd=None, scaleIO=None, secret=None, storageos=None, vsphereVolume=None)

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

parameters

• name str - name of the volume. Must be a DNS_LABEL and unique within the pod. More info
• awsElasticBlockStore Optional[AWSElasticBlockStoreVolumeSource] - awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info
• azureDisk Optional[AzureDiskVolumeSource] - azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
• azureFile Optional[AzureFileVolumeSource] - azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
• cephfs Optional[CephFSVolumeSource] - cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
• cinder Optional[CinderVolumeSource] - cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info
• configMap Optional[ConfigMapVolumeSource] - configMap represents a configMap that should populate this volume
• csi Optional[CSIVolumeSource] - csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
• downwardAPI Optional[DownwardAPIVolumeSource] - downwardAPI represents downward API about the pod that should populate this volume
• emptyDir Optional[EmptyDirVolumeSource] - emptyDir represents a temporary directory that shares a pod's lifetime. More info
• ephemeral Optional[EphemeralVolumeSource] - ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.
• fc Optional[FCVolumeSource] - fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
• flexVolume Optional[FlexVolumeSource] - flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
• flocker Optional[FlockerVolumeSource] - flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
• gcePersistentDisk Optional[GCEPersistentDiskVolumeSource] - gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info
• gitRepo Optional[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.
• glusterfs Optional[GlusterfsVolumeSource] - glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info
• hostPath Optional[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
• image Optional[ImageVolumeSource] - image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:
• Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
• iscsi Optional[ISCSIVolumeSource] - iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info
• nfs Optional[NFSVolumeSource] - nfs represents an NFS mount on the host that shares a pod's lifetime More info
• persistentVolumeClaim Optional[PersistentVolumeClaimVolumeSource] - persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info
• photonPersistentDisk Optional[PhotonPersistentDiskVolumeSource] - photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
• portworxVolume Optional[PortworxVolumeSource] - portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
• projected Optional[ProjectedVolumeSource] - projected items for all in one resources secrets, configmaps, and downward API
• quobyte Optional[QuobyteVolumeSource] - quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
• rbd Optional[RBDVolumeSource] - rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info
• scaleIO Optional[ScaleIOVolumeSource] - scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
• secret Optional[SecretVolumeSource] - secret represents a secret that should populate this volume. More info
• storageos Optional[StorageOSVolumeSource] - storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
• vsphereVolume Optional[VsphereVirtualDiskVolumeSource] - vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.

VolumeDevice

class lightkube.models.core_v1.VolumeDevice(devicePath, name)

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

parameters

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

VolumeMount

class lightkube.models.core_v1.VolumeMount(mountPath, name, mountPropagation=None, readOnly=None, recursiveReadOnly=None, subPath=None, subPathExpr=None)

VolumeMount describes a mounting of a Volume within a container.

parameters

• mountPath str - Path within the container at which the volume should be mounted. Must not contain ':'.
• name str - This must match the Name of a Volume.
• mountPropagation Optional[str] - mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
• readOnly Optional[bool] - Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
• recursiveReadOnly Optional[str] - RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason. If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None). If this field is not specified, it is treated as an equivalent of Disabled.
• subPath Optional[str] - Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
• subPathExpr Optional[str] - Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

VolumeMountStatus

class lightkube.models.core_v1.VolumeMountStatus(mountPath, name, readOnly=None, recursiveReadOnly=None)

VolumeMountStatus shows status of volume mounts.

parameters

• mountPath str - MountPath corresponds to the original VolumeMount.
• name str - Name corresponds to the name of the original VolumeMount.
• readOnly Optional[bool] - ReadOnly corresponds to the original VolumeMount.
• recursiveReadOnly Optional[str] - RecursiveReadOnly must be set to Disabled, Enabled, or unspecified (for non-readonly mounts). An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled, depending on the mount result.

VolumeNodeAffinity

class lightkube.models.core_v1.VolumeNodeAffinity(required=None)

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

parameters

• required Optional[NodeSelector] - required specifies hard node constraints that must be met.

VolumeProjection

class lightkube.models.core_v1.VolumeProjection(clusterTrustBundle=None, configMap=None, downwardAPI=None, secret=None, serviceAccountToken=None)

Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.

parameters

• clusterTrustBundle Optional[ClusterTrustBundleProjection] - ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
• configMap Optional[ConfigMapProjection] - configMap information about the configMap data to project
• downwardAPI Optional[DownwardAPIProjection] - downwardAPI information about the downwardAPI data to project
• secret Optional[SecretProjection] - secret information about the secret data to project
• serviceAccountToken Optional[ServiceAccountTokenProjection] - serviceAccountToken is information about the serviceAccountToken data to project

VolumeResourceRequirements

class lightkube.models.core_v1.VolumeResourceRequirements(limits=None, requests=None)

VolumeResourceRequirements describes the storage resource requirements for a volume.

parameters

• limits Optional[dict] - Limits describes the maximum amount of compute resources allowed. More info
• requests Optional[dict] - Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info

VsphereVirtualDiskVolumeSource

class lightkube.models.core_v1.VsphereVirtualDiskVolumeSource(volumePath, fsType=None, storagePolicyID=None, storagePolicyName=None)

Represents a vSphere volume resource.

parameters

• volumePath str - volumePath is the path that identifies vSphere volume vmdk
• fsType Optional[str] - fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
• storagePolicyID Optional[str] - storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
• storagePolicyName Optional[str] - storagePolicyName is the storage Policy Based Management (SPBM) profile name.

WeightedPodAffinityTerm

class lightkube.models.core_v1.WeightedPodAffinityTerm(podAffinityTerm, weight)

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

parameters

• podAffinityTerm PodAffinityTerm - Required. A pod affinity term, associated with the corresponding weight.
• weight int - weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

WindowsSecurityContextOptions

class lightkube.models.core_v1.WindowsSecurityContextOptions(gmsaCredentialSpec=None, gmsaCredentialSpecName=None, hostProcess=None, runAsUserName=None)

WindowsSecurityContextOptions contain Windows-specific options and credentials.

parameters

• gmsaCredentialSpec Optional[str] - GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
• gmsaCredentialSpecName Optional[str] - GMSACredentialSpecName is the name of the GMSA credential spec to use.
• hostProcess Optional[bool] - HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
• runAsUserName Optional[str] - The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.