package
1.33.0-alpha.2
Repository: https://github.com/kubernetes/kubernetes.git
Documentation: pkg.go.dev
# Packages
Package install installs the v1 monolithic api, making it available as an option to all of the API encoding/decoding machinery.
Package v1 is the v1 version of the API.
Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.
# Constants
AnnotationLoadBalancerSourceRangesKey is the key of the annotation on a service to set allowed ingress ranges on their LoadBalancers
It should be a comma-separated list of CIDRs, e.g.
AnnotationTopologyMode can be used to enable or disable Topology Aware Routing for a Service.
AppArmorProfileTypeLocalhost indicates that a profile pre-loaded on the node should be used.
AppArmorProfileTypeRuntimeDefault indicates that the container runtime's default AppArmor profile should be used.
AppArmorProfileTypeUnconfined indicates that no AppArmor profile should be enforced.
Defines cache mode and kinds for Azure data disk.
Defines cache mode and kinds for Azure data disk.
Defines cache mode and kinds for Azure data disk.
Defines cache mode and kinds for Azure data disk.
Defines cache mode and kinds for Azure data disk.
Defines cache mode and kinds for Azure data disk.
BasicAuthPasswordKey is the key of the password or token for SecretTypeBasicAuth secrets.
BasicAuthUsernameKey is the key of the username for SecretTypeBasicAuth secrets.
BetaStorageClassAnnotation represents the beta/previous StorageClass annotation.
used for PersistentVolumeClaims that are bound.
used for PersistentVolumeClaims that lost their underlying PersistentVolume.
used for PersistentVolumeClaims that are not yet bound.
ClusterIPNone - do not assign a cluster IP no proxying required and no environment variables should be created for pods.
These are the valid conditions for the component.
These are valid condition statuses.
These are valid condition statuses.
These are valid condition statuses.
ContainersReady indicates whether all containers in the pod are ready.
DefaultClientIPServiceAffinitySeconds is the default timeout seconds of Client IP based session affinity - 3 hours.
DefaultHardPodAffinitySymmetricWeight is the weight of implicit PreferredDuringScheduling affinity rule.
DefaultProcMount uses the container runtime defaults for readonly and masked paths for /proc.
Default resource requests prefix.
DeprecatedAnnotationTopologyAwareHints can be used to enable or disable Topology Aware Hints for a Service.
DeprecatedAppArmorAnnotationKeyPrefix is the prefix to an annotation key specifying a container's apparmor profile.
DeprecatedAppArmorAnnotationValueLocalhostPrefix is the prefix for specifying profiles loaded on the node.
DeprecatedAppArmorAnnotationValueRuntimeDefault is the profile specifying the runtime default.
DeprecatedAppArmorAnnotationValueUnconfined is the Unconfined AppArmor profile.
DeprecatedSeccompProfileDockerDefault represents the default seccomp profile used by docker.
DisruptionTarget indicates the pod is about to be terminated due to a disruption (such as preemption, eviction API or garbage-collection).
DNSClusterFirst indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
DNSClusterFirstWithHostNet indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings.
DNSDefault indicates that the pod should use the default (as determined by kubelet) DNS settings.
DNSNone indicates that the pod should use empty DNS settings.
DockerConfigJSONKey is the key of the required data for SecretTypeDockerConfigJson secrets.
DockerConfigKey is the key of the required data for SecretTypeDockercfg secrets.
DoNotSchedule instructs the scheduler not to schedule the pod when constraints are not satisfied.
EndpointsLastChangeTriggerTime is the annotation key, set for endpoints objects, that represents the timestamp (stored as RFC 3339 date-time string, e.g.
EndpointsOverCapacity will be set on an Endpoints resource when it exceeds the maximum capacity of 1000 addresses.
Information only and will not cause any problems.
These events are to warn that something might go wrong.
Command to run for remote command execution.
Enable stderr for remote command execution.
Enable stdin for remote command execution.
Enable stdout for remote command execution.
Enable TTY for remote command execution.
These are internal finalizer values to Kubernetes, must be qualified name unless defined here or in metav1.
FSGroupChangeAlways indicates that volume's ownership and permissions should always be changed whenever volume is mounted inside a Pod.
FSGroupChangeOnRootMismatch indicates that volume's ownership and permissions will be changed only when permission and ownership of root directory does not match with expected permissions on the volume.
GroupName is the group name use in this package.
A block device must exist at the given path.
A character device must exist at the given path.
A directory must exist at the given path.
If nothing exists at the given path, an empty directory will be created there as needed with file mode 0755, having the same group and ownership with Kubelet.
A file must exist at the given path.
If nothing exists at the given path, an empty file will be created there as needed with file mode 0644, having the same group and ownership with Kubelet.
A UNIX socket must exist at the given path.
For backwards compatible, leave it empty if unset.
ImagePolicyFailedOpenKey is added to pods created by failing open when the image policy webhook backend fails.
IPFamilyPolicyPreferDualStack indicates that this service prefers dual-stack when the cluster is configured for dual-stack.
IPFamilyPolicyRequireDualStack indicates that this service requires dual-stack.
IPFamilyPolicySingleStack indicates that this service is required to have a single IPFamily.
IPv4Protocol indicates that this IP is IPv4 protocol.
IPv6Protocol indicates that this IP is IPv6 protocol.
LastAppliedConfigAnnotation is the annotation used to store the previous configuration of a resource for use in a three way diff by UpdateApplyAnnotation.
LimitTypeContainer defines limit that applies to all containers in a namespace.
LimitTypePersistentVolumeClaim defines limit that applies to all persistent volume claims in a namespace.
LimitTypePod defines limit that applies to all pods in a namespace.
These are valid values for OSName.
LoadBalancerIPModeProxy indicates that traffic is delivered to the node or pod with the destination set to the node's IP and port or the pod's IP and port.
LoadBalancerIPModeVIP indicates that traffic is delivered to the node with the destination set to the load-balancer's IP and port.
LoadBalancerPortsError represents the condition of the requested ports on the cloud load balancer instance.
LogStreamAll represents the combined stdout and stderr.
LogStreamStderr is the stream type for stderr.
LogStreamStdout is the stream type for stdout.
MaxClientIPServiceAffinitySeconds is the max timeout seconds of Client IP based session affinity - 1 day.
MaxSecretSize represents the max secret size.
MigratedPluginsAnnotationKey is the annotation key, set for CSINode objects, that is a comma-separated list of in-tree plugins that will be serviced by the CSI backend on the Node represented by CSINode.
MirrorPodAnnotationKey represents the annotation key set by kubelets when creating mirror pods.
MixedProtocolNotSupported error in PortStatus means that the cloud provider can't ensure the port on the load balancer because mixed values of protocols on the same LoadBalancer type of Service are not supported by the cloud provider.
MountOptionAnnotation defines mount option annotation used in PVs.
MountPropagationBidirectional means that the volume in a container will receive new mounts from the host or other containers, and its own mounts will be propagated from the container to the host or other containers.
MountPropagationHostToContainer means that the volume in a container will receive new mounts from the host or other containers, but filesystems mounted inside the container won't be propagated to the host or other containers.
MountPropagationNone means that the volume in a container will not receive new mounts from the host or other containers, and filesystems mounted inside the container won't be propagated to the host or other containers.
NamespaceActive means the namespace is available for use in the system.
NamespaceAll is the default argument to specify on a context when you want to list or filter resources across all namespaces.
NamespaceDefault means the object is in the default namespace which is applied when not specified by clients.
These are valid conditions of a namespace.
These are valid conditions of a namespace.
These are valid conditions of a namespace.
NamespaceNodeLease is the namespace where we place node lease objects (used for node heartbeats).
NamespaceNone is the argument for a context when there is no namespace.
NamespacePublic is the namespace where we place public info (ConfigMaps).
NamespaceSystem is the system namespace where we place system components.
NamespaceTerminating means the namespace is undergoing graceful termination.
NodeDiskPressure means the kubelet is under pressure due to insufficient available disk.
NodeExternalDNS identifies a DNS name which resolves to an IP address which has the characteristics of a NodeExternalIP.
NodeExternalIP identifies an IP address which is, in some way, intended to be more usable from outside the cluster then an internal IP, though no specific semantics are defined.
NodeHostName identifies a name of the node.
NodeInclusionPolicyHonor means use this scheduling directive when calculating pod topology spread skew.
NodeInclusionPolicyIgnore means ignore this scheduling directive when calculating pod topology spread skew.
NodeInternalDNS identifies a DNS name which resolves to an IP address which has the characteristics of a NodeInternalIP.
NodeInternalIP identifies an IP address which is assigned to one of the node's network interfaces.
NodeMemoryPressure means the kubelet is under pressure due to insufficient available memory.
NodeNetworkUnavailable means that network for the node is not correctly configured.
NodePending means the node has been created/added by the system, but not configured.
NodeReady means kubelet is healthy and ready to accept pods.
NodeRunning means the node has been configured and has Kubernetes components running.
These are valid values of NodeSelectorOperator.
These are valid values of NodeSelectorOperator.
These are valid values of NodeSelectorOperator.
These are valid values of NodeSelectorOperator.
These are valid values of NodeSelectorOperator.
These are valid values of NodeSelectorOperator.
NodeTerminated means the node has been removed from the cluster.
NonConvertibleAnnotationPrefix annotation key prefix used to identify non-convertible json paths.
'NotRequired' means Kubernetes will try to resize the container without restarting it, if possible.
ObjectTTLAnnotationKey represents a suggestion for kubelet for how long it can cache an object (e.g.
PersistentVolumeBlock means the volume will not be formatted with a filesystem and will remain a raw block device.
PersistentVolumeClaimControllerResizeError indicates an error while resizing volume for size in the controller.
State set when resize has failed in resize controller with a terminal unrecoverable error.
State set when resize controller starts resizing the volume in control-plane.
PersistentVolumeClaimFileSystemResizePending - controller resize is finished and a file system resize is pending on node.
Infeasible indicates that the request has been rejected as invalid by the CSI driver.
InProgress indicates that the volume is being modified.
Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing.
PersistentVolumeClaimNodeResizeError indicates an error while resizing volume for size in the node.
State set when resizing has failed in kubelet with a terminal unrecoverable error.
State set when kubelet starts resizing the volume.
State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node.
An user trigger resize of pvc has been started.
Volume is being modified.
Applying the target VolumeAttributesClass encountered an error.
PersistentVolumeFilesystem means the volume will be or is formatted with a filesystem.
PersistentVolumeReclaimDelete means the volume will be deleted from Kubernetes on release from its claim.
PersistentVolumeReclaimRecycle means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim.
PersistentVolumeReclaimRetain means the volume will be left in its current phase (Released) for manual reclamation by the administrator.
PodDeletionCost can be used to set to an int32 that represent the cost of deleting a pod compared to other pods belonging to the same ReplicaSet.
PodFailed means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).
PodInitialized means that all init containers in the pod have started successfully.
PodPending means the pod has been accepted by the system, but one or more of the containers has not been started.
PodQOSBestEffort is the BestEffort qos class.
PodQOSBurstable is the Burstable qos class.
PodQOSGuaranteed is the Guaranteed qos class.
PodReady means the pod is able to service requests and should be added to the load balancing pools of all matching services.
Node cannot resize the pod at this time and will keep retrying.
Requested pod resize is not feasible and will not be re-evaluated.
Pod resources resize has been accepted by node and is being actuated.
Pod resources resize has been requested and will be evaluated by node.
PodRunning means the pod has been bound to a node and all of the containers have been started.
PodScheduled represents status of the scheduling process for this pod.
PodSucceeded means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.
PodUnknown means that 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.
Name of header that specifies a request ID used to associate the error and data streams for a single forwarded connection.
Name of header that specifies the port being forwarded.
PreemptLowerPriority means that pod can preempt other pods with lower priority.
PreemptNever means that pod never preempts other pods with lower priority.
PreferAvoidPodsAnnotationKey represents the key of preferAvoidPods data (json serialized) in the Annotations of a Node.
ProtocolSCTP is the SCTP protocol.
ProtocolTCP is the TCP protocol.
ProtocolUDP is the UDP protocol.
PullAlways means that kubelet always attempts to pull the latest image.
PullIfNotPresent means that kubelet pulls if the image isn't present on disk.
PullNever means that kubelet never pulls an image, but only uses a local image.
can be mounted in read-only mode to many hosts.
can be mounted in read/write mode to many hosts.
can be mounted read/write mode to exactly 1 host.
can be mounted read/write mode to exactly 1 pod cannot be used in combination with other access modes.
RecursiveReadOnlyDisabled disables recursive-readonly mode.
RecursiveReadOnlyEnabled enables recursive-readonly mode, or raise an error.
RecursiveReadOnlyIfPossible enables recursive-readonly mode if possible.
ReplicationControllerReplicaFailure is added in a replication controller when one of its pods fails to be created due to insufficient quota, limit ranges, pod security policy, node selectors, etc.
ResourceAttachableVolumesPrefix is the name prefix for storage resource limits.
resource.k8s.io devices requested with a certain DeviceClass, number.
ResourceConfigMaps, number.
CPU, in cores.
ResourceDefaultNamespacePrefix is the default namespace prefix.
Local ephemeral storage, in bytes.
ResourceHugePagesPrefix is the name prefix for huge page resources (alpha).
CPU limit, in cores.
Local ephemeral storage limit, in bytes.
Memory limit, in bytes.
Memory, in bytes.
ResourcePersistentVolumeClaims, number.
Pods, number.
ResourceQuotas, number.
Match all pod objects that have best effort quality of service.
Match all pod objects that have cross-namespace pod (anti)affinity mentioned.
Match all pod objects that do not have best effort quality of service.
Match all pod objects where spec.activeDeadlineSeconds is nil.
Match all pod objects that have priority class mentioned.
Match all pod objects where spec.activeDeadlineSeconds >=0.
ReplicationControllers, number.
CPU request, in cores.
Local ephemeral storage request, in bytes.
HugePages request, in bytes.
Memory request, in bytes.
Storage request, in bytes.
ResourceSecrets, number.
Services, number.
ResourceServicesLoadBalancers, number.
ResourceServicesNodePorts, number.
Volume size, in bytes (e,g.
'RestartContainer' means Kubernetes will resize the container in-place by stopping and starting the container when new resources are applied.
These are valid restart policies.
These are valid restart policies.
These are valid restart policies.
ScheduleAnyway instructs the scheduler to schedule the pod even if constraints are not satisfied.
These are the valid values for ScopeSelectorOperator.
These are the valid values for ScopeSelectorOperator.
These are the valid values for ScopeSelectorOperator.
These are the valid values for ScopeSelectorOperator.
SeccompContainerAnnotationKeyPrefix represents the key of a seccomp profile applied to one container of a pod.
SeccompPodAnnotationKey represents the key of a seccomp profile applied to all containers of a pod.
SeccompProfileRuntimeDefault represents the default seccomp profile used by container runtime.
SeccompProfileTypeLocalhost represents custom made profiles stored on the node's disk.
SeccompProfileTypeRuntimeDefault represents the default container runtime seccomp profile.
SeccompProfileTypeUnconfined is when no seccomp profile is applied (A.K.A.
SecretTypeBasicAuth contains data needed for basic authentication.
SecretTypeBootstrapToken is used during the automated bootstrap process (first implemented by kubeadm).
SecretTypeDockercfg contains a dockercfg file that follows the same format rules as ~/.dockercfg
Required fields: - Secret.Data[".dockercfg"] - a serialized ~/.dockercfg file.
SecretTypeDockerConfigJSON contains a dockercfg file that follows the same format rules as ~/.docker/config.json
Required fields: - Secret.Data[".dockerconfigjson"] - a serialized ~/.docker/config.json file.
SecretTypeOpaque is the default; arbitrary user-defined data.
SecretTypeServiceAccountToken contains a token that identifies a service account to the API
Required fields: - Secret.Annotations["kubernetes.io/service-account.name"] - the name of the ServiceAccount the token identifies - Secret.Annotations["kubernetes.io/service-account.uid"] - the UID of the ServiceAccount the token identifies - Secret.Data["token"] - a token that identifies the service account to the API.
SecretTypeSSHAuth contains data needed for SSH authentication.
SecretTypeTLS contains information about a TLS client or server secret.
MountOption mounts all eligible Pod volumes with `-o context` mount option.
Recursive relabeling of all Pod volumes by the container runtime.
ServiceAccountKubeconfigKey is the key of the optional kubeconfig data for SecretTypeServiceAccountToken secrets.
ServiceAccountNameKey is the key of the required annotation for SecretTypeServiceAccountToken secrets.
ServiceAccountNamespaceKey is the key of the optional namespace to use as the default for namespaced API calls.
ServiceAccountRootCAKey is the key of the optional root certificate authority for SecretTypeServiceAccountToken secrets.
ServiceAccountTokenKey is the key of the required data for SecretTypeServiceAccountToken secrets.
ServiceAccountUIDKey is the key of the required annotation for SecretTypeServiceAccountToken secrets.
ServiceAffinityClientIP is the Client IP based.
ServiceAffinityNone - no session affinity.
ServiceExternalTrafficPolicyCluster routes traffic to all endpoints.
ServiceExternalTrafficPolicyLocal preserves the source IP of the traffic by routing only to endpoints on the same node as the traffic was received on (dropping the traffic if there are no local endpoints).
ServiceInternalTrafficPolicyCluster routes traffic to all endpoints.
ServiceInternalTrafficPolicyLocal routes traffic only to endpoints on the same node as the traffic was received on (dropping the traffic if there are no local endpoints).
Indicates a preference for routing traffic to endpoints that are topologically proximate to the client.
ServiceTypeClusterIP means a service will only be accessible inside the cluster, via the ClusterIP.
ServiceTypeExternalName means a service consists of only a reference to an external name that kubedns or equivalent will return as a CNAME record, with no exposing or proxying of any pods involved.
ServiceTypeLoadBalancer means a service will be exposed via an external load balancer (if the cloud provider supports it), in addition to 'NodePort' type.
ServiceTypeNodePort means a service will be exposed on one port of every node, in addition to 'ClusterIP' type.
SSHAuthPrivateKey is the key of the required SSH private key for SecretTypeSSHAuth secrets.
use whatever the default is for the node.
use hugepages.
prefix for full medium notation HugePages-<size>.
use memory (tmpfs).
Name of header that specifies stream type.
Value for streamType header for data stream.
Value for streamType header for error stream.
Value for streamType header for terminal resize stream.
Value for streamType header for stderr stream.
Value for streamType header for stdin stream.
Value for streamType header for stdout stream.
SupplementalGroupsPolicyMerge means that the container's provided SupplementalGroups and FsGroup (specified in SecurityContext) will be merged with the primary user's groups as defined in the container image (in /etc/group).
SupplementalGroupsPolicyStrict means that the container's provided SupplementalGroups and FsGroup (specified in SecurityContext) will be used instead of any groups defined in the container image.
Evict any already-running pods that do not tolerate the taint.
Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running.
Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely.
TaintsAnnotationKey represents the key of taints data (json serialized) in the Annotations of a Node.
TerminationMessageFallbackToLogsOnError will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
TerminationMessagePathDefault means the default path to capture the application termination message running in a container.
TerminationMessageReadFile is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
TLSCertKey is the key for tls certificates in a TLS secret.
TLSPrivateKeyKey is the key for the private key field in a TLS secret.
These are valid values for TolerationOperator.
These are valid values for TolerationOperator.
TolerationsAnnotationKey represents the key of tolerations data (json serialized) in the Annotations of a Pod.
UnmaskedProcMount bypasses the default masking behavior of the container runtime and ensures the newly created /proc the container stays intact with no modifications.
URISchemeHTTP means that the scheme used will be http://.
URISchemeHTTPS means that the scheme used will be https://.
used for PersistentVolumes that are not yet bound Available volumes are held by the binder and matched to PersistentVolumeClaims.
used for PersistentVolumes that are bound.
used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim.
used for PersistentVolumes that are not available.
used for PersistentVolumes where the bound PersistentVolumeClaim was deleted released volumes must be recycled before becoming available again this phase is used by the persistent volume claim binder to signal to another process to reclaim the resource.
These are valid values for OSName.
# Variables
AddToScheme represents a func that can be used to apply all the registered funcs in a scheme.
SchemeBuilder object to register various known types.
SchemeGroupVersion is group version used to register these objects.
# Structs
Affinity is a group of affinity scheduling rules.
AppArmorProfile defines a pod or container's AppArmor settings.
AttachedVolume describes a volume attached to a node.
AvoidPods describes pods that should avoid this node.
AWSElasticBlockStoreVolumeSource represents a Persistent Disk resource in AWS.
AzureDiskVolumeSource represents an Azure Data Disk mount on the host and bind mount to the pod.
AzureFilePersistentVolumeSource represents an Azure File Service mount on the host and bind mount to the pod.
AzureFileVolumeSource azureFile represents an Azure File Service mount on the host and bind mount to the pod.
Binding ties one object to another; for example, a pod is bound to a node by a scheduler.
Capabilities represent POSIX capabilities that can be added or removed to a running container.
CephFSPersistentVolumeSource represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
CephFSVolumeSource represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
CinderPersistentVolumeSource represents a cinder volume resource in Openstack.
CinderVolumeSource represents a cinder volume resource in Openstack.
ClientIPConfig represents the configurations of Client IP based session affinity.
ClusterTrustBundleProjection allows a pod to access the `.spec.trustBundle` field of a ClusterTrustBundle object in an auto-updating file.
ComponentCondition represents the condition of a component.
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
ComponentStatusList represents the list of component statuses Deprecated: This API is deprecated in v1.19+.
ConfigMap holds configuration data for components or applications to consume.
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
ConfigMapKeySelector selects a key from a ConfigMap.
ConfigMapList is a resource containing a list of ConfigMap objects.
Deprecated: ConfigMapNodeConfigSource represents the config map of a node.
ConfigMapProjection adapts a ConfigMap into a projected volume.
ConfigMapVolumeSource adapts a ConfigMap into a volume.
Container represents a single container that is expected to be run on the host.
ContainerImage describe a container image.
ContainerPort represents a network port in a single container.
ContainerResizePolicy represents resource resize policy for the container.
ContainerState holds a possible state of container.
ContainerStateRunning represents the running state of a container.
ContainerStateTerminated represents the terminated state of a container.
ContainerStateWaiting represents the waiting state of a container.
ContainerStatus contains details for the current status of this container.
ContainerUser represents user identity information.
CSIPersistentVolumeSource represents storage that is managed by an external CSI volume driver.
CSIVolumeSource represents a source location of a volume to mount, managed by an external CSI driver.
DaemonEndpoint contains information about a single Daemon endpoint.
DownwardAPIProjection represents downward API info for projecting into a projected volume.
DownwardAPIVolumeFile represents a single file containing information from the downward API.
DownwardAPIVolumeSource represents a volume containing downward API info.
EmptyDirVolumeSource represents an empty directory for a pod.
EndpointAddress is a tuple that describes single IP address.
EndpointPort is a tuple that describes a single port.
Endpoints is a collection of endpoints that implement the actual service.
EndpointsList is a list of endpoints.
EndpointSubset is a group of addresses with a common set of ports.
EnvFromSource represents the source of a set of ConfigMaps or Secrets.
EnvVar represents an environment variable present in a Container.
EnvVarSource represents a source for the value of an EnvVar.
An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging.
EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer.
EphemeralVolumeSource represents an ephemeral volume that is handled by a normal storage driver.
Event is a report of an event somewhere in the cluster.
EventList is a list of events.
EventSeries represents a series ov events.
EventSource represents the source from which an event is generated.
ExecAction describes a "run in container" action.
FCVolumeSource represents a Fibre Channel volume.
FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.
FlexVolumeSource represents a generic volume resource that is provisioned/attached using an exec based plugin.
FlockerVolumeSource represents a Flocker volume mounted by the Flocker agent.
GCEPersistentDiskVolumeSource represents a Persistent Disk resource in Google Compute Engine.
GitRepoVolumeSource represents a volume that is populated with the contents of a git repository.
GlusterfsPersistentVolumeSource represents a Glusterfs mount that lasts the lifetime of a pod.
GlusterfsVolumeSource represents a Glusterfs mount that lasts the lifetime of a pod.
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
HostIP represents a single IP address allocated to the host.
HostPathVolumeSource represents a host path mapped into a pod.
HTTPGetAction describes an action based on HTTP Get requests.
HTTPHeader describes a custom header to be used in HTTP probes.
ImageVolumeSource represents a image volume resource.
ISCSIPersistentVolumeSource represents an ISCSI disk.
ISCSIVolumeSource represents an ISCSI disk.
KeyToPath maps a string key to a path within a volume.
Lifecycle describes actions that the management system should take in response to container lifecycle events.
LifecycleHandler defines a specific action that should be taken in a lifecycle hook.
LimitRange sets resource usage limits for each kind of resource in a Namespace.
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
LimitRangeList is a list of LimitRange items.
LimitRangeSpec defines a min/max usage limit for resources that match on kind.
LinuxContainerUser represents user identity information in Linux containers.
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
LoadBalancerStatus represents the status of a load-balancer.
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
LocalVolumeSource represents directly-attached storage with node affinity.
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
Namespace provides a scope for Names.
NamespaceCondition contains details about state of namespace.
NamespaceList is a list of Namespaces.
NamespaceSpec describes the attributes on a Namespace.
NamespaceStatus is information about the current status of a Namespace.
NFSVolumeSource represents an NFS mount that lasts the lifetime of a pod.
Node is a worker node in Kubernetes The name of the node according to etcd is in ObjectMeta.Name.
NodeAddress represents node's address.
NodeAffinity is a group of node affinity scheduling rules.
NodeCondition represents the node's condition.
Deprecated: NodeConfigSource specifies a source of node configuration.
NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
NodeDaemonEndpoints lists ports opened by daemons running on the Node.
NodeFeatures describes the set of features implemented by the CRI implementation.
NodeList is a list of nodes.
NodeProxyOptions is the query options to a Node's proxy call.
NodeRuntimeHandler is a set of runtime handler information.
NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
NodeSelector 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.
NodeSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
NodeSelectorTerm represents expressions and fields required to select nodes.
NodeSpec describes the attributes that a node is created with.
NodeStatus is information about the current status of a node.
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
ObjectFieldSelector selects an APIVersioned field of an object.
ObjectReference contains enough information to let you inspect or modify the referred object.
PersistentVolume struct captures the details of the implementation of PV storage.
PersistentVolumeClaim is a user's request for and claim to a persistent volume.
PersistentVolumeClaimCondition represents the current condition of PV claim.
PersistentVolumeClaimList represents the list of PV claims.
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes.
PersistentVolumeClaimStatus represents the status of PV claim.
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.
PersistentVolumeList represents a list of PVs.
PersistentVolumeSource is similar to VolumeSource but meant for the administrator who creates PVs.
PersistentVolumeSpec has most of the details required to define a persistent volume.
PersistentVolumeStatus represents the status of PV storage.
PhotonPersistentDiskVolumeSource represents a Photon Controller persistent disk resource.
Pod is a collection of containers, used as either input (create, update) or as output (list, get).
PodAffinity is a group of inter pod affinity scheduling rules.
PodAffinityTerm defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running.
PodAntiAffinity is a group of inter pod anti affinity scheduling rules.
PodAttachOptions is the query options to a Pod's remote attach call TODO: merge w/ PodExecOptions below for stdin, stdout, etc.
PodCondition represents pod's condition.
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
PodDNSConfigOption defines DNS resolver options of a pod.
PodExecOptions is the query options to a Pod's remote exec call.
PodIP represents a single IP address allocated to the pod.
PodList is a list of Pods.
PodLogOptions is the query options for a Pod's logs REST call.
PodOS defines the OS parameters of a pod.
PodPortForwardOptions is the query options to a Pod's port forward call.
PodProxyOptions is the query options to a Pod's proxy call.
PodReadinessGate contains the reference to a pod condition.
PodResourceClaim references exactly one ResourceClaim through a ClaimSource.
PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate.
PodSchedulingGate is associated to a Pod to guard its scheduling.
PodSecurityContext holds pod-level security attributes and common container settings.
PodSignature describes the class of pods that should avoid this node.
PodSpec is a description of a pod.
PodStatus represents information about the status of a pod.
PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded.
PodTemplate describes a template for creating copies of a predefined pod.
PodTemplateList is a list of PodTemplates.
PodTemplateSpec describes the data a pod should have when created from a template.
PortStatus represents the error condition of a service port.
PortworxVolumeSource represents a Portworx volume resource.
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
PreferAvoidPodsEntry describes a class of pods that should avoid this node.
PreferredSchedulingTerm represents an empty preferred scheduling term matches all objects with implicit weight 0 (i.e.
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ProbeHandler defines a specific action that should be taken in a probe.
ProjectedVolumeSource represents a projected volume source.
QuobyteVolumeSource represents a Quobyte mount that lasts the lifetime of a pod.
RangeAllocation is an opaque API object (not exposed to end users) that can be persisted to record the global allocation state of the cluster.
RBDPersistentVolumeSource represents a Rados Block Device mount that lasts the lifetime of a pod.
RBDVolumeSource represents a Rados Block Device mount that lasts the lifetime of a pod.
ReplicationController represents the configuration of a replication controller.
ReplicationControllerCondition describes the state of a replication controller at a certain point.
ReplicationControllerList is a collection of replication controllers.
ReplicationControllerSpec is the specification of a replication controller.
ReplicationControllerStatus represents the current status of a replication controller.
ResourceClaim references one entry in PodSpec.ResourceClaims.
ResourceFieldSelector represents container resources (cpu, memory) and their output format.
ResourceHealth represents the health of a resource.
ResourceQuota sets aggregate quota restrictions enforced per namespace.
ResourceQuotaList is a list of ResourceQuota items.
ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
ResourceQuotaStatus defines the enforced hard limits and observed use.
ResourceRequirements describes the compute resource requirements.
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume that can be defined by a an admin via a storage class, for instance.
ScaleIOVolumeSource represents a persistent ScaleIO volume.
ScopedResourceSelectorRequirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
ScopeSelector represents the AND of the selectors represented by the scoped-resource selector terms.
SeccompProfile defines a pod/container's seccomp profile settings.
Secret holds secret data of a certain type.
SecretEnvSource selects a Secret to populate the environment variables with.
SecretKeySelector selects a key of a Secret.
SecretList represents the list of secrets.
SecretProjection adapts a secret into a projected volume.
SecretReference represents a Secret Reference.
SecretVolumeSource adapts a Secret into a volume.
SecurityContext holds security configuration that will be applied to a container.
SELinuxOptions are the labels to be applied to the container.
SerializedReference represents a serialized object reference.
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.
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.
ServiceAccountList is a list of ServiceAccount objects.
ServiceAccountTokenProjection represents a projected service account token volume.
ServiceList holds a list of services.
ServicePort represents the port on which the service is exposed.
ServiceProxyOptions is the query options to a Service's proxy call.
ServiceSpec describes the attributes that a user creates on a service.
ServiceStatus represents the current status of a service.
SessionAffinityConfig represents the configurations of session affinity.
SleepAction describes a "sleep" action.
StorageOSPersistentVolumeSource represents a StorageOS persistent volume resource.
StorageOSVolumeSource represents a StorageOS persistent volume resource.
Sysctl defines a kernel parameter to be set.
Taint represents taint that can be applied to the node.
TCPSocketAction describes an action based on opening a socket.
Toleration represents the toleration object that can be attached to a pod.
TopologySelectorLabelRequirement is a selector that matches given label.
TopologySelectorTerm represents the result of label queries.
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
Volume represents a named volume in a pod that may be accessed by any containers in the pod.
VolumeDevice describes a mapping of a raw block device within a container.
VolumeMount describes a mounting of a Volume within a container.
VolumeMountStatus shows status of volume mounts.
VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
VolumeProjection that may be projected along with other supported volume types.
VolumeResourceRequirements describes the storage resource requirements for a volume.
VolumeSource represents the source location of a volume to mount.
VsphereVirtualDiskVolumeSource represents a vSphere volume resource.
WeightedPodAffinityTerm represents the weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s).
WindowsSecurityContextOptions contain Windows-specific options and credentials.
# Type aliases
+enum.
AzureDataDiskCachingMode defines the caching mode for Azure data disk.
AzureDataDiskKind defines the kind of Azure data disk.
Capability represent POSIX capabilities type.
+enum When a controller receives persistentvolume claim update with ClaimResourceStatus for a resource that it does not recognizes, then it should ignore that update and let other controllers handle it.
ComponentConditionType defines type and constants for component health validation.
ConditionStatus defines conditions of resources.
ContainerRestartPolicy is the restart policy for a single container.
DNSPolicy defines how a pod's DNS will be configured.
FinalizerName is the name identifying a finalizer during namespace lifecycle.
HostPathType defines the type of host path for PV.
IPFamily represents the IP Family (IPv4 or IPv6).
IPFamilyPolicy represents the dual-stack-ness requested or required by a Service.
LimitType defines a type of object that is limited.
List holds a list of objects, which may not be known by the server.
LoadBalancerIPMode represents the mode of the LoadBalancer ingress IP.
MountPropagationMode describes mount propagation.
NamespaceConditionType defines constants reporting on status during namespace lifetime and deletion progress.
NamespacePhase defines the phase in which the namespace is.
NodeAddressType defines the node's address type.
NodeConditionType defines node's condition.
NodeInclusionPolicy defines the type of node inclusion policy +enum.
NodePhase defines the phase in which a node is in.
NodeSelectorOperator is the set of operators that can be used in a node selector requirement.
OSName is the set of OS'es that can be used in OS.
PersistentVolumeAccessMode defines various access modes for PV.
PersistentVolumeClaimConditionType defines the condition of PV claim.
+enum New statuses can be added in the future.
PersistentVolumeClaimPhase defines the phase of PV claim.
PersistentVolumeMode describes how a volume is intended to be consumed, either Block or Filesystem.
PersistentVolumePhase defines the phase in which a PV is.
PersistentVolumeReclaimPolicy describes a policy for end-of-life maintenance of persistent volumes.
PodConditionType defines the condition of pod.
PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume when volume is mounted.
PodPhase is a label for the condition of a pod at the current time.
PodQOSClass defines the supported qos classes of Pods.
PodResizeStatus shows status of desired resize of a pod's containers.
PodSELinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
PreemptionPolicy describes a policy for if/when to preempt a pod.
ProcMountType defines the type of proc mount.
Protocol defines network protocols supported for things like container ports.
PullPolicy describes a policy for if/when to pull a container image.
RecursiveReadOnlyMode describes recursive-readonly mode.
ReplicationControllerConditionType defines the conditions of a replication controller.
ResourceID is calculated based on the source of this resource health information.
ResourceList is a set of (resource name, quantity) pairs.
ResourceName is the name identifying various resources in a ResourceList.
ResourceQuotaScope defines a filter that must match each object tracked by a quota.
ResourceResizeRestartPolicy specifies how to handle container resource resize.
RestartPolicy describes how the container should be restarted.
ScopeSelectorOperator is the set of operators that can be used in a scope selector requirement.
SeccompProfileType defines the supported seccomp profile types.
SecretType defines the types of secrets.
ServiceAffinity Type string.
ServiceExternalTrafficPolicy describes the endpoint-selection policy for traffic to external service entrypoints (NodePorts, ExternalIPs, and LoadBalancer IPs).
ServiceInternalTrafficPolicy describes the endpoint-selection policy for traffic sent to the ClusterIP.
ServiceType string describes ingress methods for a service.
StorageMedium defines ways that storage can be allocated to a volume.
SupplementalGroupsPolicy defines how supplemental groups of the first container processes are calculated.
TaintEffect defines the effects of Taint.
TerminationMessagePolicy describes how termination messages are retrieved from a container.
TolerationOperator is the set of operators that can be used in a toleration.
UniqueVolumeName defines the name of attached volume.
UnsatisfiableConstraintAction defines the actions that can be taken for an unsatisfiable constraint.
URIScheme identifies the scheme used for connection to a host for Get actions.