package
0.33.0-alpha.2
Repository: https://github.com/kubernetes/api.git
Documentation: pkg.go.dev

# Functions

Resource takes an unqualified resource and returns a Group qualified GroupResource.

# 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.
Label value is the network location of kube-apiserver stored as <ip:port> Stored in APIServer Identity lease objects to view what address is used for peer proxy.
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
ContainersReady indicates whether all containers in the pod are ready.
No description provided by the author
The default value for enableServiceLinks attribute.
RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule.
DefaultProcMount uses the container runtime defaults for readonly and masked paths for /proc.
Default resource requests prefix.
DefaultSchedulerName defines the name of default scheduler.
DefaultTerminationGracePeriodSeconds indicates the default duration in seconds a pod needs to terminate gracefully.
DeprecatedAnnotationTopologyAwareHints can be used to enable or disable Topology Aware Hints for a Service.
DeprecatedAppArmorBetaContainerAnnotationKeyPrefix is the prefix to an annotation key specifying a container's apparmor profile.
DeprecatedAppArmorBetaProfileNamePrefix is the prefix for specifying profiles loaded on the node.
DeprecatedAppArmorBetaProfileNameUnconfined is the Unconfined AppArmor profile.
DeprecatedAppArmorBetaProfileRuntimeDefault is the profile specifying the runtime default.
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.
No description provided by the author
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.
IPFamilyUnknown indicates that this IP is unknown protocol.
IPv4Protocol indicates that this IP is IPv4 protocol.
IPv6Protocol indicates that this IP is IPv6 protocol.
IsHeadlessService is added by Controller to an Endpoint denoting if its parent Service is Headless.
No description provided by the author
deprecated.
deprecated.
No description provided by the author
No description provided by the author
No description provided by the author
LabelMetadataName is the label name which, in-tree, is used to automatically label namespaces, so they can be selected easily by tools which require definitive labels.
LabelNamespaceNodeRestriction is a forbidden label namespace that kubelets may not self-set when the NodeRestriction admission plugin is enabled.
LabelNamespaceSuffixKubelet is an allowed label namespace suffix kubelets can self-set ([*.]kubelet.kubernetes.io/*).
LabelNamespaceSuffixNode is an allowed label namespace suffix kubelets can self-set ([*.]node.kubernetes.io/*).
LabelNodeExcludeBalancers specifies that the node should not be considered as a target for external load-balancers which use nodes as a second hop (e.g.
No description provided by the author
No description provided by the author
No description provided by the author
LabelWindowsBuild is used on Windows nodes to specify the Windows build number starting with v1.17.0.
deprecated.
deprecated.
deprecated.
deprecated.
LastAppliedConfigAnnotation is the annotation used to store the previous configuration of a resource for use in a three way diff by UpdateApplyAnnotation.
Limit that applies to all containers in a namespace.
Limit that applies to all persistent volume claims in a namespace.
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.
LoadBalancerPortsErrorReason reason in ServiceStatus condition LoadBalancerPortsError means the LoadBalancer was not able to be configured correctly.
LogStreamAll represents the combined stdout and stderr.
LogStreamStderr is the stream type for stderr.
LogStreamStdout is the stream type for stdout.
No description provided by the author
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 publish 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.
NamespaceContentRemaining contains information about resources remaining in a namespace.
NamespaceDefault means the object is in the default namespace which is applied when not specified by clients.
NamespaceDeletionContentFailure contains information about namespace deleter errors during deletion of resources.
NamespaceDeletionDiscoveryFailure contains information about namespace deleter errors during resource discovery.
NamespaceDeletionGVParsingFailure contains information about namespace deleter errors parsing GV for legacy types.
NamespaceFinalizersRemaining contains information about which finalizers are on resources remaining in a namespace.
NamespaceNodeLease is the namespace where we place node lease objects (used for node heartbeats).
NamespaceTerminating means the namespace is undergoing graceful termination.
NamespaceTerminatingCause is returned as a defaults.cause item when a change is forbidden due to the namespace being terminated.
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.
NodePIDPressure means the kubelet is under pressure due to insufficient available PID.
NodeReady means kubelet is healthy and ready to accept pods.
NodeRunning means the node has been configured and has Kubernetes components running.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NodeTerminated means the node has been removed from the cluster.
NonConvertibleAnnotationPrefix is the 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.
PersistentVolumeClaimResizing - a 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.
PodReadyToStartContainers pod sandbox is successfully configured and the pod is ready to launch containers.
PodReasonPreemptionByScheduler reason in DisruptionTarget pod condition indicates that the disruption was initiated by scheduler's preemption.
PodReasonSchedulerError reason in PodScheduled PodCondition means that some internal error happens during scheduling, for example due to nodeAffinity parsing errors.
PodReasonSchedulingGated reason in PodScheduled PodCondition means that the scheduler skips scheduling the pod because one or more scheduling gates are still present.
PodReasonTerminationByKubelet reason in DisruptionTarget pod condition indicates that the termination is initiated by kubelet.
PodReasonUnschedulable reason in PodScheduled PodCondition means that the scheduler can't schedule the pod right now, for example due to insufficient resources in the cluster.
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.
No description provided by the author
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 in read/write mode to exactly 1 host.
can be mounted in 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.
Name prefix for storage resource limits.
resource.k8s.io devices requested with a certain DeviceClass, number.
ResourceConfigMaps, number.
CPU, in cores.
Default namespace prefix.
Local ephemeral storage, in bytes.
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
ScheduleAnyway instructs the scheduler to schedule the pod even if constraints are not satisfied.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SeccompContainerAnnotationKeyPrefix represents the key of a seccomp profile applied to one container of a pod.
SeccompLocalhostProfileNamePrefix is the prefix for specifying profiles loaded from the node's disk.
SeccompPodAnnotationKey represents the key of a seccomp profile applied to all containers of a pod.
SeccompProfileNameUnconfined is the unconfined seccomp profile.
SeccompProfileRuntimeDefault represents the default seccomp profile used by container runtime.
SeccompProfileTypeLocalhost indicates a profile defined in a file on the node should be used.
SeccompProfileTypeRuntimeDefault represents the default container runtime seccomp profile.
SeccompProfileTypeUnconfined indicates 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.
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 authetication.
SecretTypeTLS contains information about a TLS client or server secret.
No description provided by the author
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).
No description provided by the author
No description provided by the author
ServiceInternalTrafficPolicyCluster routes traffic to all endpoints.
ServiceInternalTrafficPolicyLocal routes traffic only to endpoints on the same node as the client pod (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 cluster IP.
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, assume anything we don't explicitly handle is this.
use hugepages.
prefix for full medium notation HugePages-<size>.
use memory (e.g.
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.
TaintNodeDiskPressure will be added when node has disk pressure and removed when node has enough disk.
TaintNodeMemoryPressure will be added when node has memory pressure and removed when node has enough memory.
TaintNodeNetworkUnavailable will be added when node's network is unavailable and removed when network becomes ready.
TaintNodeNotReady will be added when node is not ready and removed when node becomes ready.
TaintNodeOutOfService can be added when node is out of service in case of a non-graceful shutdown.
TaintNodePIDPressure will be added when node has pid pressure and removed when node has enough pid.
TaintNodeUnreachable will be added when node becomes unreachable (corresponding to NodeReady status ConditionUnknown) and removed when node becomes reachable (NodeReady status ConditionTrue).
TaintNodeUnschedulable will be added when node becomes unschedulable and removed when node becomes schedulable.
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.
No description provided by the author
No description provided by the author
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 in tact 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

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
We only register manually written functions here.
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.
Represents a Persistent Disk resource in AWS.
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
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.
Adds and removes POSIX capabilities from running containers.
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
Represents a cinder volume resource in Openstack.
Represents a cinder volume resource in Openstack.
ClientIPConfig represents the configurations of Client IP based session affinity.
ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.
Information about the condition of a component.
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
Status of all the conditions for the component as a list of ComponentStatus objects.
ConfigMap holds configuration data for pods to consume.
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
Selects a key from a ConfigMap.
ConfigMapList is a resource containing a list of ConfigMap objects.
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.
Adapts a ConfigMap into a projected volume.
Adapts a ConfigMap into a volume.
A single application container that you want to run within a pod.
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 is a running state of a container.
ContainerStateTerminated is a terminated state of a container.
ContainerStateWaiting is a waiting state of a container.
ContainerStatus contains details for the current status of this container.
ContainerUser represents user identity information.
Represents storage that is managed by an external CSI volume driver.
Represents a source location of a volume to mount, managed by an external CSI driver.
DaemonEndpoint contains information about a single Daemon endpoint.
Represents downward API info for projecting into a projected volume.
DownwardAPIVolumeFile represents information to create the file containing the pod field.
DownwardAPIVolumeSource represents a volume containing downward API info.
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.
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 contain information on series of events, i.e.
EventSource contains information for an event.
ExecAction describes a "run in container" action.
Represents a Fibre Channel volume.
FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
Represents a Flocker volume mounted by the Flocker agent.
Represents a Persistent Disk resource in Google Compute Engine.
Represents a volume that is populated with the contents of a git repository.
Represents a Glusterfs mount that lasts the lifetime of a pod.
Represents a Glusterfs mount that lasts the lifetime of a pod.
GRPCAction specifies an action involving a GRPC service.
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.
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.
Represents an ISCSI disk.
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.
Local 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.
Represents an NFS mount that lasts the lifetime of a pod.
Node is a worker node in Kubernetes.
NodeAddress contains information for the node's address.
Node affinity is a group of node affinity scheduling rules.
NodeCondition contains condition information for a node.
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 the whole list of all Nodes which have been registered with master.
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.
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.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
A null or empty node selector term matches no objects.
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 (PV) is a storage resource provisioned by an administrator.
PersistentVolumeClaim is a user's request for and claim to a persistent volume.
PersistentVolumeClaimCondition contains details about state of pvc.
PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes.
PersistentVolumeClaimStatus is the current status of a persistent volume claim.
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.
PersistentVolumeList is a list of PersistentVolume items.
PersistentVolumeSource is similar to VolumeSource but meant for the administrator who creates PVs.
PersistentVolumeSpec is the specification of a persistent volume.
PersistentVolumeStatus is the current status of a persistent volume.
Represents a Photon Controller persistent disk resource.
Pod is a collection of containers that can run on a host.
Pod affinity is a group of inter pod affinity scheduling rules.
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.
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
PodAttachOptions is the query options to a Pod's remote attach call.
PodCondition contains details for the current condition of this pod.
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 when using WebSockets.
PodProxyOptions is the query options to a Pod's proxy call.
PodReadinessGate contains the reference to a pod condition.
PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.
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.
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.
Describes a class of pods that should avoid this node.
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.
Represents a projected volume source.
Represents a Quobyte mount that lasts the lifetime of a pod.
RangeAllocation is not a public type.
Represents a Rados Block Device mount that lasts the lifetime of a pod.
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 +structType=atomic.
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.
ResourceStatus represents the status of a single resource allocated to a Pod.
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume.
ScaleIOVolumeSource represents a persistent ScaleIO volume.
A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
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 is a list of Secret.
Adapts a secret into a projected volume.
SecretReference represents a Secret Reference.
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 is a reference to serialized object.
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 contains information on service's port.
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.
Represents a StorageOS persistent volume resource.
Represents a StorageOS persistent volume resource.
Sysctl defines a kernel parameter to be set.
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
TCPSocketAction describes an action based on opening a socket.
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
A topology selector requirement is a selector that matches given label.
A topology selector term 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.
TypedObjectReference contains enough information to let you locate the typed referenced object.
Volume represents a named volume in a pod that may be accessed by any container 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.
Projection that may be projected along with other supported volume types.
VolumeResourceRequirements describes the storage resource requirements for a volume.
Represents the source of a volume to mount.
Represents a vSphere volume resource.
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.
+enum.
+enum.
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.
Type and constants for component health validation.
No description provided by the author
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.
+enum.
IPFamily represents the IP Family (IPv4 or IPv6).
IPFamilyPolicy represents the dual-stack-ness requested or required by a Service +enum.
for backwards compat +enum.
LimitType is 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.
No description provided by the author
+enum.
No description provided by the author
No description provided by the author
NodeInclusionPolicy defines the type of node inclusion policy +enum.
+enum.
A node selector operator 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.
+enum.
PersistentVolumeClaimConditionType defines the condition of PV claim.
+enum New statuses can be added in the future.
+enum.
PersistentVolumeMode describes how a volume is intended to be consumed, either Block or Filesystem.
+enum.
PersistentVolumeReclaimPolicy describes a policy for end-of-life maintenance of persistent volumes.
PodConditionType is a valid value for PodCondition.Type.
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.
+enum.
Protocol defines network protocols supported for things like container ports.
PullPolicy describes a policy for if/when to pull a container image +enum.
RecursiveReadOnlyMode describes recursive-readonly mode.
No description provided by the author
No description provided by the author
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.
A ResourceQuotaScope defines a filter that must match each object tracked by a quota +enum.
ResourceResizeRestartPolicy specifies how to handle container resource resize.
RestartPolicy describes how the container should be restarted.
A scope selector operator is the set of operators that can be used in a scope selector requirement.
SeccompProfileType defines the supported seccomp profile types.
No description provided by the author
Session Affinity Type string +enum.
ServiceExternalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs.
for backwards compat +enum.
ServiceInternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP.
for backwards compat +enum.
Service Type string describes ingress methods for a service +enum.
StorageMedium defines ways that storage can be allocated to a volume.
SupplementalGroupsPolicy defines how supplemental groups of the first container processes are calculated.
+enum.
TerminationMessagePolicy describes how termination messages are retrieved from a container.
A toleration operator is the set of operators that can be used in a toleration.
No description provided by the author
+enum.
URIScheme identifies the scheme used for connection to a host for Get actions +enum.