Structs
Represents a Persistent Disk resource in AWS.
Affinity is a group of affinity scheduling rules.
AttachedVolume describes a volume attached to a node
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. Deprecated in 1.7, please use the bindings subresource of pods instead.
Represents storage that is managed by an external CSI volume driver (Beta feature)
Represents a source location of a volume to mount, managed by an external CSI driver
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. 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.
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 represents the configurations of Client IP based session affinity.
Information about the condition of a component.
ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
ConfigMap holds configuration data for pods to consume.
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
Selects a key from a ConfigMap.
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
Adapts a ConfigMap into a projected volume.
Adapts a ConfigMap into a volume.
Optional parameters of Pod::connect_delete_namespaced_pod_proxy
Optional parameters of Pod::connect_delete_namespaced_pod_proxy_with_path
Optional parameters of Service::connect_delete_namespaced_service_proxy
Optional parameters of Service::connect_delete_namespaced_service_proxy_with_path
Optional parameters of Node::connect_delete_node_proxy
Optional parameters of Node::connect_delete_node_proxy_with_path
Optional parameters of Pod::connect_get_namespaced_pod_attach
Optional parameters of Pod::connect_get_namespaced_pod_exec
Optional parameters of Pod::connect_get_namespaced_pod_portforward
Optional parameters of Pod::connect_get_namespaced_pod_proxy
Optional parameters of Pod::connect_get_namespaced_pod_proxy_with_path
Optional parameters of Service::connect_get_namespaced_service_proxy
Optional parameters of Service::connect_get_namespaced_service_proxy_with_path
Optional parameters of Node::connect_get_node_proxy
Optional parameters of Node::connect_get_node_proxy_with_path
Optional parameters of Pod::connect_patch_namespaced_pod_proxy
Optional parameters of Pod::connect_patch_namespaced_pod_proxy_with_path
Optional parameters of Service::connect_patch_namespaced_service_proxy
Optional parameters of Service::connect_patch_namespaced_service_proxy_with_path
Optional parameters of Node::connect_patch_node_proxy
Optional parameters of Node::connect_patch_node_proxy_with_path
Optional parameters of Pod::connect_post_namespaced_pod_attach
Optional parameters of Pod::connect_post_namespaced_pod_exec
Optional parameters of Pod::connect_post_namespaced_pod_portforward
Optional parameters of Pod::connect_post_namespaced_pod_proxy
Optional parameters of Pod::connect_post_namespaced_pod_proxy_with_path
Optional parameters of Service::connect_post_namespaced_service_proxy
Optional parameters of Service::connect_post_namespaced_service_proxy_with_path
Optional parameters of Node::connect_post_node_proxy
Optional parameters of Node::connect_post_node_proxy_with_path
Optional parameters of Pod::connect_put_namespaced_pod_proxy
Optional parameters of Pod::connect_put_namespaced_pod_proxy_with_path
Optional parameters of Service::connect_put_namespaced_service_proxy
Optional parameters of Service::connect_put_namespaced_service_proxy_with_path
Optional parameters of Node::connect_put_node_proxy
Optional parameters of Node::connect_put_node_proxy_with_path
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.
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 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.
DaemonEndpoint contains information about a single Daemon endpoint.
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 represents information to create the file containing the pod field
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
EndpointAddress is a tuple that describes single IP address.
EndpointPort is a tuple that describes a single port.
EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{“ip”: “10.10.1.1”}, {“ip”: “10.10.2.2”}], Ports: [{“name”: “a”, “port”: 8675}, {“name”: “b”, “port”: 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]
Endpoints is a collection of endpoints that implement the actual service. Example: Name: “mysvc”, Subsets: [ { Addresses: [{“ip”: “10.10.1.1”}, {“ip”: “10.10.2.2”}], Ports: [{“name”: “a”, “port”: 8675}, {“name”: “b”, “port”: 309}] }, { Addresses: [{“ip”: “10.10.3.3”}], Ports: [{“name”: “a”, “port”: 93}, {“name”: “b”, “port”: 76}] }, ]
EnvFromSource represents the source of a set of ConfigMaps
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. 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.
Represents an ephemeral volume that is handled by a normal storage driver.
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.
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
EventSource contains information for an event.
ExecAction describes a “run in container” action.
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 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. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
Represents a Persistent Disk resource in Google Compute Engine.
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.
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
HTTPGetAction describes an action based on HTTP Get requests.
HTTPHeader describes a custom header to be used in HTTP probes
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
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. 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 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 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.
LimitRangeSpec defines a min/max usage limit for resources that match on kind.
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 (Beta feature)
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
Namespace provides a scope for Names. Use of multiple namespaces is optional.
NamespaceCondition contains details about state of namespace.
NamespaceSpec describes the attributes on a Namespace.
NamespaceStatus is information about the current status of a Namespace.
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
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. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
NodeDaemonEndpoints lists ports opened by daemons running on the Node.
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. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
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. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
PersistentVolumeClaim is a user’s request for and claim to a persistent volume
PersistentVolumeClaimCondition contails details about state of pvc
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. 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).
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. This resource is created by clients and scheduled onto hosts.
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.
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.
IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.
PodOS defines the OS parameters of a pod.
PodReadinessGate contains the reference to a pod condition
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.
PodSpec is a description of a pod.
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.
PodTemplate describes a template for creating copies of a predefined pod.
PodTemplateSpec describes the data a pod should have when created from a template
PortworxVolumeSource represents a Portworx volume resource.
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 describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
Represents a projected volume source
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
Optional parameters of ComponentStatus::read_component_status
Optional parameters of Namespace::read_namespace
Optional parameters of Namespace::read_namespace_status
Optional parameters of ConfigMap::read_namespaced_config_map
Optional parameters of Endpoints::read_namespaced_endpoints
Optional parameters of Event::read_namespaced_event
Optional parameters of LimitRange::read_namespaced_limit_range
Optional parameters of PersistentVolumeClaim::read_namespaced_persistent_volume_claim
Optional parameters of PersistentVolumeClaim::read_namespaced_persistent_volume_claim_status
Optional parameters of Pod::read_namespaced_pod_ephemeralcontainers
Optional parameters of Pod::read_namespaced_pod_log
Optional parameters of Pod::read_namespaced_pod
Optional parameters of Pod::read_namespaced_pod_status
Optional parameters of PodTemplate::read_namespaced_pod_template
Optional parameters of ReplicationController::read_namespaced_replication_controller
Optional parameters of ReplicationController::read_namespaced_replication_controller_status
Optional parameters of ResourceQuota::read_namespaced_resource_quota
Optional parameters of ResourceQuota::read_namespaced_resource_quota_status
Optional parameters of Secret::read_namespaced_secret
Optional parameters of ServiceAccount::read_namespaced_service_account
Optional parameters of Service::read_namespaced_service
Optional parameters of Service::read_namespaced_service_status
Optional parameters of Node::read_node
Optional parameters of Node::read_node_status
Optional parameters of PersistentVolume::read_persistent_volume
Optional parameters of PersistentVolume::read_persistent_volume_status
ReplicationController represents the configuration of a replication controller.
ReplicationControllerCondition describes the state of a replication controller at a certain point.
ReplicationControllerSpec is the specification of a replication controller.
ReplicationControllerStatus represents the current status of a replication controller.
ResourceFieldSelector represents container resources (cpu, memory) and their output format
ResourceQuota sets aggregate quota restrictions enforced per namespace
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.
SELinuxOptions are the labels to be applied to the container
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
ScaleIOVolumeSource represents a persistent ScaleIO volume
A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
SeccompProfile defines a pod/container’s seccomp profile settings. Only one profile source may be set.
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 selects a Secret to populate the environment variables with.
SecretKeySelector selects a key of a Secret.
Adapts a secret into a projected volume.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
Adapts a Secret into a volume.
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.
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
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).
ServicePort contains information on service’s port.
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.
Represents a StorageOS persistent volume resource.
Represents a StorageOS persistent volume resource.
Sysctl defines a kernel parameter to be set
TCPSocketAction describes an action based on opening a socket
The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.
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. This is an alpha feature and may change in the future.
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.
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 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.
VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
Projection that may be projected along with other supported volume types
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.
Enums
Use <ReadComponentStatusResponse as Response>::try_from_parts to parse the HTTP response body of ComponentStatus::read_component_status
Use <ReadNamespaceResponse as Response>::try_from_parts to parse the HTTP response body of Namespace::read_namespace
Use <ReadNamespaceStatusResponse as Response>::try_from_parts to parse the HTTP response body of Namespace::read_namespace_status
Use <ReadNamespacedConfigMapResponse as Response>::try_from_parts to parse the HTTP response body of ConfigMap::read_namespaced_config_map
Use <ReadNamespacedEndpointsResponse as Response>::try_from_parts to parse the HTTP response body of Endpoints::read_namespaced_endpoints
Use <ReadNamespacedEventResponse as Response>::try_from_parts to parse the HTTP response body of Event::read_namespaced_event
Use <ReadNamespacedLimitRangeResponse as Response>::try_from_parts to parse the HTTP response body of LimitRange::read_namespaced_limit_range
Use <ReadNamespacedPersistentVolumeClaimResponse as Response>::try_from_parts to parse the HTTP response body of PersistentVolumeClaim::read_namespaced_persistent_volume_claim
Use <ReadNamespacedPersistentVolumeClaimStatusResponse as Response>::try_from_parts to parse the HTTP response body of PersistentVolumeClaim::read_namespaced_persistent_volume_claim_status
Use <ReadNamespacedPodEphemeralcontainersResponse as Response>::try_from_parts to parse the HTTP response body of Pod::read_namespaced_pod_ephemeralcontainers
Use <ReadNamespacedPodLogResponse as Response>::try_from_parts to parse the HTTP response body of Pod::read_namespaced_pod_log
Use <ReadNamespacedPodResponse as Response>::try_from_parts to parse the HTTP response body of Pod::read_namespaced_pod
Use <ReadNamespacedPodStatusResponse as Response>::try_from_parts to parse the HTTP response body of Pod::read_namespaced_pod_status
Use <ReadNamespacedPodTemplateResponse as Response>::try_from_parts to parse the HTTP response body of PodTemplate::read_namespaced_pod_template
Use <ReadNamespacedReplicationControllerResponse as Response>::try_from_parts to parse the HTTP response body of ReplicationController::read_namespaced_replication_controller
Use <ReadNamespacedReplicationControllerStatusResponse as Response>::try_from_parts to parse the HTTP response body of ReplicationController::read_namespaced_replication_controller_status
Use <ReadNamespacedResourceQuotaResponse as Response>::try_from_parts to parse the HTTP response body of ResourceQuota::read_namespaced_resource_quota
Use <ReadNamespacedResourceQuotaStatusResponse as Response>::try_from_parts to parse the HTTP response body of ResourceQuota::read_namespaced_resource_quota_status
Use <ReadNamespacedSecretResponse as Response>::try_from_parts to parse the HTTP response body of Secret::read_namespaced_secret
Use <ReadNamespacedServiceAccountResponse as Response>::try_from_parts to parse the HTTP response body of ServiceAccount::read_namespaced_service_account
Use <ReadNamespacedServiceResponse as Response>::try_from_parts to parse the HTTP response body of Service::read_namespaced_service
Use <ReadNamespacedServiceStatusResponse as Response>::try_from_parts to parse the HTTP response body of Service::read_namespaced_service_status
Use <ReadNodeResponse as Response>::try_from_parts to parse the HTTP response body of Node::read_node
Use <ReadNodeStatusResponse as Response>::try_from_parts to parse the HTTP response body of Node::read_node_status
Use <ReadPersistentVolumeResponse as Response>::try_from_parts to parse the HTTP response body of PersistentVolume::read_persistent_volume
Use <ReadPersistentVolumeStatusResponse as Response>::try_from_parts to parse the HTTP response body of PersistentVolume::read_persistent_volume_status