Module v1

Module v1 

Source

Structs§

Affinity
Affinity is a group of affinity scheduling rules.
AppArmorProfile
AppArmorProfile defines a pod or container’s AppArmor settings. +union
AttachedVolume
AttachedVolume describes a volume attached to a node
AvoidPods
AvoidPods describes pods that should avoid this node. This is the value for a Node annotation with key scheduler.alpha.kubernetes.io/preferAvoidPods and will eventually become a field of NodeStatus.
AwsElasticBlockStoreVolumeSource
Represents a Persistent Disk resource in AWS.
AzureDiskVolumeSource
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
AzureFilePersistentVolumeSource
AzureFile 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
Binding ties one object to another; for example, a pod is bound to a node by a scheduler.
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
Capabilities
Adds and removes POSIX capabilities from running containers.
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. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
CinderVolumeSource
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
ClientIpConfig
ClientIPConfig represents the configurations of Client IP based session affinity.
ClusterTrustBundleProjection
ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.
ComponentCondition
Information about the condition of a component.
ComponentStatus
ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
ComponentStatusList
Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+
ConfigMap
ConfigMap holds configuration data for pods to consume.
ConfigMapEnvSource
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
ConfigMapKeySelector
Selects a key from a ConfigMap. +structType=atomic
ConfigMapList
ConfigMapList is a resource containing a list of ConfigMap objects.
ConfigMapNodeConfigSource
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
ConfigMapProjection
Adapts a ConfigMap into a projected volume.
ConfigMapVolumeSource
Adapts a ConfigMap into a volume.
Container
A single application container that you want to run within a pod.
ContainerImage
Describe a container image
ContainerPort
ContainerPort represents a network port in a single container.
ContainerResizePolicy
ContainerResizePolicy represents resource resize policy for the container.
ContainerState
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
ContainerStateRunning
ContainerStateRunning is a running state of a container.
ContainerStateTerminated
ContainerStateTerminated is a terminated state of a container.
ContainerStateWaiting
ContainerStateWaiting is a waiting state of a container.
ContainerStatus
ContainerStatus contains details for the current status of this container.
ContainerUser
ContainerUser represents user identity information
DaemonEndpoint
DaemonEndpoint contains information about a single Daemon endpoint.
DownwardAPIProjection
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
DownwardAPIVolumeFile
DownwardAPIVolumeFile represents information to create the file containing the pod field
DownwardAPIVolumeSource
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
EmptyDirVolumeSource
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
EndpointAddress
EndpointAddress is a tuple that describes single IP address. Deprecated: This API is deprecated in v1.33+. +structType=atomic
EndpointPort
EndpointPort is a tuple that describes a single port. Deprecated: This API is deprecated in v1.33+. +structType=atomic
EndpointSubset
EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
Endpoints
Endpoints is a collection of endpoints that implement the actual service. Example:
EndpointsList
EndpointsList is a list of endpoints. Deprecated: This API is deprecated in v1.33+.
EnvFromSource
EnvFromSource represents the source of a set of ConfigMaps or Secrets
EnvVar
EnvVar represents an environment variable present in a Container.
EnvVarSource
EnvVarSource represents a source for the value of an EnvVar.
EphemeralContainer
An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation.
EphemeralContainerCommon
EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer. This separate type allows easy conversion from EphemeralContainer to Container and allows separate documentation for the fields of EphemeralContainer. When a new field is added to Container it must be added here as well.
EphemeralVolumeSource
Represents an ephemeral volume that is handled by a normal storage driver.
Event
Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
EventList
EventList is a list of events.
EventSeries
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
EventSource
EventSource contains information for an event.
ExecAction
ExecAction describes a “run in container” action.
FcVolumeSource
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
FlexPersistentVolumeSource
FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.
FlexVolumeSource
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
FlockerVolumeSource
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
GcePersistentDiskVolumeSource
Represents a Persistent Disk resource in Google Compute Engine.
GitRepoVolumeSource
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
GlusterfsPersistentVolumeSource
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
GlusterfsVolumeSource
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
GrpcAction
GRPCAction specifies an action involving a GRPC service.
HostAlias
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
HostIp
HostIP represents a single IP address allocated to the host.
HostPathVolumeSource
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
HttpGetAction
HTTPGetAction describes an action based on HTTP Get requests.
HttpHeader
HTTPHeader describes a custom header to be used in HTTP probes
ImageVolumeSource
ImageVolumeSource represents a image volume resource.
IscsiPersistentVolumeSource
ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
IscsiVolumeSource
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
KeyToPath
Maps a string key to a path within a volume.
Lifecycle
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
LifecycleHandler
LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
LimitRange
LimitRange sets resource usage limits for each kind of resource in a Namespace.
LimitRangeItem
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
LimitRangeList
LimitRangeList is a list of LimitRange items.
LimitRangeSpec
LimitRangeSpec defines a min/max usage limit for resources that match on kind.
LinuxContainerUser
LinuxContainerUser represents user identity information in Linux containers
List
List holds a list of objects, which may not be known by the server.
LoadBalancerIngress
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
LoadBalancerStatus
LoadBalancerStatus represents the status of a load-balancer.
LocalObjectReference
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
LocalVolumeSource
Local represents directly-attached storage with node affinity
ModifyVolumeStatus
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation
Namespace
Namespace provides a scope for Names. Use of multiple namespaces is optional.
NamespaceCondition
NamespaceCondition contains details about state of namespace.
NamespaceList
NamespaceList is a list of Namespaces.
NamespaceSpec
NamespaceSpec describes the attributes on a Namespace.
NamespaceStatus
NamespaceStatus is information about the current status of a Namespace.
NfsVolumeSource
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
Node
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
NodeAddress
NodeAddress contains information for the node’s address.
NodeAffinity
Node affinity is a group of node affinity scheduling rules.
NodeCondition
NodeCondition contains condition information for a node.
NodeConfigSource
NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
NodeConfigStatus
NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
NodeDaemonEndpoints
NodeDaemonEndpoints lists ports opened by daemons running on the Node.
NodeFeatures
NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.
NodeList
NodeList is the whole list of all Nodes which have been registered with master.
NodeProxyOptions
NodeProxyOptions is the query options to a Node’s proxy call.
NodeRuntimeHandler
NodeRuntimeHandler is a set of runtime handler information.
NodeRuntimeHandlerFeatures
NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
NodeSelector
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. +structType=atomic
NodeSelectorRequirement
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
NodeSelectorTerm
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +structType=atomic
NodeSpec
NodeSpec describes the attributes that a node is created with.
NodeStatus
NodeStatus is information about the current status of a node.
NodeSwapStatus
NodeSwapStatus represents swap memory information.
NodeSystemInfo
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
ObjectFieldSelector
ObjectFieldSelector selects an APIVersioned field of an object. +structType=atomic
ObjectReference
ObjectReference contains enough information to let you inspect or modify the referred object.
PersistentVolume
PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
PersistentVolumeClaim
PersistentVolumeClaim is a user’s request for and claim to a persistent volume
PersistentVolumeClaimCondition
PersistentVolumeClaimCondition contains details about state of pvc
PersistentVolumeClaimList
PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
PersistentVolumeClaimSpec
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
PersistentVolumeClaimStatus
PersistentVolumeClaimStatus is the current status of a persistent volume claim.
PersistentVolumeClaimTemplate
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
PersistentVolumeClaimVolumeSource
PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
PersistentVolumeList
PersistentVolumeList is a list of PersistentVolume items.
PersistentVolumeSource
PersistentVolumeSource is similar to VolumeSource but meant for the administrator who creates PVs. Exactly one of its members must be set.
PersistentVolumeSpec
PersistentVolumeSpec is the specification of a persistent volume.
PersistentVolumeStatus
PersistentVolumeStatus is the current status of a persistent volume.
PhotonPersistentDiskVolumeSource
Represents a Photon Controller persistent disk resource.
Pod
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
PodAffinity
Pod affinity 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 matches that of any node on which a pod of the set of pods is running
PodAntiAffinity
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
PodAttachOptions
PodAttachOptions is the query options to a Pod’s remote attach call.
PodCondition
PodCondition contains details for the current condition of this pod.
PodDnsConfig
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
PodDnsConfigOption
PodDNSConfigOption defines DNS resolver options of a pod.
PodExecOptions
PodExecOptions is the query options to a Pod’s remote exec call.
PodIp
PodIP represents a single IP address allocated to the pod.
PodList
PodList is a list of Pods.
PodLogOptions
PodLogOptions is the query options for a Pod’s logs REST call.
PodOs
PodOS defines the OS parameters of a pod.
PodPortForwardOptions
PodPortForwardOptions is the query options to a Pod’s port forward call when using WebSockets. The port query parameter must specify the port or ports (comma separated) to forward over. Port forwarding over SPDY does not use these options. It requires the port to be passed in the port header as part of request.
PodProxyOptions
PodProxyOptions is the query options to a Pod’s proxy call.
PodReadinessGate
PodReadinessGate contains the reference to a pod condition
PodResourceClaim
PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.
PodResourceClaimStatus
PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate. It stores the generated name for the corresponding ResourceClaim.
PodSchedulingGate
PodSchedulingGate is associated to a Pod to guard its scheduling.
PodSecurityContext
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
PodSignature
Describes the class of pods that should avoid this node. Exactly one field should be set.
PodSpec
PodSpec is a description of a pod.
PodStatus
PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.
PodStatusResult
PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded
PodTemplate
PodTemplate describes a template for creating copies of a predefined pod.
PodTemplateList
PodTemplateList is a list of PodTemplates.
PodTemplateSpec
PodTemplateSpec describes the data a pod should have when created from a template
PortStatus
PortStatus represents the error condition of a service port
PortworxVolumeSource
PortworxVolumeSource represents a Portworx volume resource.
Preconditions
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. +k8s:openapi-gen=false
PreferAvoidPodsEntry
Describes a class of pods that should avoid this node.
PreferredSchedulingTerm
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
Probe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ProbeHandler
ProbeHandler defines a specific action that should be taken in a probe. One and only one of the fields must be specified.
ProjectedVolumeSource
Represents a projected volume source
QuobyteVolumeSource
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
RangeAllocation
RangeAllocation is not a public type.
RbdPersistentVolumeSource
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
RbdVolumeSource
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
ReplicationController
ReplicationController represents the configuration of a replication controller.
ReplicationControllerCondition
ReplicationControllerCondition describes the state of a replication controller at a certain point.
ReplicationControllerList
ReplicationControllerList is a collection of replication controllers.
ReplicationControllerSpec
ReplicationControllerSpec is the specification of a replication controller.
ReplicationControllerStatus
ReplicationControllerStatus represents the current status of a replication controller.
ResourceClaim
ResourceClaim references one entry in PodSpec.ResourceClaims.
ResourceFieldSelector
ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic
ResourceHealth
ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.
ResourceQuota
ResourceQuota sets aggregate quota restrictions enforced per namespace
ResourceQuotaList
ResourceQuotaList is a list of ResourceQuota items.
ResourceQuotaSpec
ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
ResourceQuotaStatus
ResourceQuotaStatus defines the enforced hard limits and observed use.
ResourceRequirements
ResourceRequirements describes the compute resource requirements.
ResourceStatus
ResourceStatus represents the status of a single resource allocated to a Pod.
ScaleIoPersistentVolumeSource
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
ScaleIoVolumeSource
ScaleIOVolumeSource represents a persistent ScaleIO volume
ScopeSelector
A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. +structType=atomic
ScopedResourceSelectorRequirement
A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
SeLinuxOptions
SELinuxOptions are the labels to be applied to the container
SeccompProfile
SeccompProfile defines a pod/container’s seccomp profile settings. Only one profile source may be set. +union
Secret
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
SecretEnvSource
SecretEnvSource selects a Secret to populate the environment variables with.
SecretKeySelector
SecretKeySelector selects a key of a Secret. +structType=atomic
SecretList
SecretList is a list of Secret.
SecretProjection
Adapts a secret into a projected volume.
SecretReference
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +structType=atomic
SecretVolumeSource
Adapts a Secret into a volume.
SecurityContext
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
SerializedReference
SerializedReference is a reference to serialized object.
Service
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
ServiceAccount
ServiceAccount binds together:
ServiceAccountList
ServiceAccountList is a list of ServiceAccount objects
ServiceAccountTokenProjection
ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).
ServiceList
ServiceList holds a list of services.
ServicePort
ServicePort contains information on service’s port.
ServiceProxyOptions
ServiceProxyOptions is the query options to a Service’s proxy call.
ServiceSpec
ServiceSpec describes the attributes that a user creates on a service.
ServiceStatus
ServiceStatus represents the current status of a service.
SessionAffinityConfig
SessionAffinityConfig represents the configurations of session affinity.
SleepAction
SleepAction describes a “sleep” action.
StorageOsPersistentVolumeSource
Represents a StorageOS persistent volume resource.
StorageOsVolumeSource
Represents a StorageOS persistent volume resource.
Sysctl
Sysctl defines a kernel parameter to be set
Taint
The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.
TcpSocketAction
TCPSocketAction describes an action based on opening a socket
Toleration
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
TopologySelectorLabelRequirement
A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.
TopologySelectorTerm
A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. +structType=atomic
TopologySpreadConstraint
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
TypedLocalObjectReference
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
TypedObjectReference
TypedObjectReference contains enough information to let you locate the typed referenced object
Volume
Volume represents a named volume in a pod that may be accessed by any container in the pod.
VolumeDevice
volumeDevice describes a mapping of a raw block device within a container.
VolumeMount
VolumeMount describes a mounting of a Volume within a container.
VolumeMountStatus
VolumeMountStatus shows status of volume mounts.
VolumeNodeAffinity
VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
VolumeProjection
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
VolumeResourceRequirements
VolumeResourceRequirements describes the storage resource requirements for a volume.
VolumeSource
Represents the source of a volume to mount. Only one of its members may be specified.
VsphereVirtualDiskVolumeSource
Represents a vSphere volume resource.
WeightedPodAffinityTerm
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
WindowsSecurityContextOptions
WindowsSecurityContextOptions contain Windows-specific options and credentials.