kubernetes library

Classes

Affinity
Affinity is a group of affinity scheduling rules.
AggregationRule
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole.
APIGroup
APIGroup contains the name, the supported versions, and the preferred version of a group.
APIGroupList
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
APIResource
APIResource specifies the name of a resource and whether it is namespaced.
APIResourceList
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
APIService
APIService represents a server for a particular GroupVersion. Name must be "version.group".
APIServiceCondition
APIServiceCondition describes the state of an APIService at a particular point.
APIServiceList
APIServiceList is a list of APIService objects.
APIServiceSpec
APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.
APIServiceStatus
APIServiceStatus contains derived information about an API server.
APIVersions
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
AttachedVolume
AttachedVolume describes a volume attached to a node.
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. Deprecated in 1.7, please use the bindings subresource of pods instead.
BoundObjectReference
BoundObjectReference is a reference to an object that a token is bound to.
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.
CertificateSigningRequest
CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued.
CertificateSigningRequestCondition
CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest object.
CertificateSigningRequestList
CertificateSigningRequestList is a collection of CertificateSigningRequest objects.
CertificateSigningRequestSpec
CertificateSigningRequestSpec contains the certificate request.
CertificateSigningRequestStatus
CertificateSigningRequestStatus contains conditions used to indicate approved/denied/failed status of the request, and the issued certificate.
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.
ClusterRole
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
ClusterRoleBinding
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
ClusterRoleBindingList
ClusterRoleBindingList is a collection of ClusterRoleBindings.
ClusterRoleList
ClusterRoleList is a collection of ClusterRoles.
ComponentCondition
Information about the condition of a component.
ComponentStatus
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
ComponentStatusList
Status of all the conditions for the component as a list of ComponentStatus objects.
Condition
Condition contains details for one aspect of the current state of this API Resource.
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.
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.
ContainerResourceMetricSource
ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.
ContainerResourceMetricStatus
ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
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.
ControllerRevision
ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
ControllerRevisionList
ControllerRevisionList is a resource containing a list of ControllerRevision objects.
CronJob
CronJob represents the configuration of a single cron job.
CronJobList
CronJobList is a collection of cron jobs.
CronJobSpec
CronJobSpec describes how the job execution will look like and when it will actually run.
CronJobStatus
CronJobStatus represents the current state of a cron job.
CrossVersionObjectReference
CrossVersionObjectReference contains enough information to let you identify the referred resource.
CSIDriver
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
CSIDriverList
CSIDriverList is a collection of CSIDriver objects.
CSIDriverSpec
CSIDriverSpec is the specification of a CSIDriver.
CSINode
CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object.
CSINodeDriver
CSINodeDriver holds information about the specification of one CSI driver installed on a node.
CSINodeList
CSINodeList is a collection of CSINode objects.
CSINodeSpec
CSINodeSpec holds information about the specification of all CSI drivers installed on a node.
CSIPersistentVolumeSource
Represents storage that is managed by an external CSI volume driver (Beta feature).
CSIStorageCapacity
CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.
CSIStorageCapacityList
CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
CSIVolumeSource
Represents a source location of a volume to mount, managed by an external CSI driver.
CustomResourceColumnDefinition
CustomResourceColumnDefinition specifies a column for server side printing.
CustomResourceConversion
CustomResourceConversion describes how to convert different versions of a CR.
CustomResourceDefinition
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
CustomResourceDefinitionCondition
CustomResourceDefinitionCondition contains details for the current condition of this pod.
CustomResourceDefinitionList
CustomResourceDefinitionList is a list of CustomResourceDefinition objects.
CustomResourceDefinitionNames
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition.
CustomResourceDefinitionSpec
CustomResourceDefinitionSpec describes how a user wants their resource to appear.
CustomResourceDefinitionStatus
CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition.
CustomResourceDefinitionVersion
CustomResourceDefinitionVersion describes a version for CRD.
CustomResourceSubresources
CustomResourceSubresources defines the status and scale subresources for CustomResources.
CustomResourceSubresourceScale
CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.
CustomResourceSubresourceStatus
CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the .status JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza.
CustomResourceValidation
CustomResourceValidation is a list of validation methods for CustomResources.
DaemonEndpoint
DaemonEndpoint contains information about a single Daemon endpoint.
DaemonSet
DaemonSet represents the configuration of a daemon set.
DaemonSetCondition
DaemonSetCondition describes the state of a DaemonSet at a certain point.
DaemonSetList
DaemonSetList is a collection of daemon sets.
DaemonSetSpec
DaemonSetSpec is the specification of a daemon set.
DaemonSetStatus
DaemonSetStatus represents the current status of a daemon set.
DaemonSetUpdateStrategy
DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
DeleteOptions
DeleteOptions may be provided when deleting an API object.
Deployment
Deployment enables declarative updates for Pods and ReplicaSets.
DeploymentCondition
DeploymentCondition describes the state of a deployment at a certain point.
DeploymentList
DeploymentList is a list of Deployments.
DeploymentSpec
DeploymentSpec is the specification of the desired behavior of the Deployment.
DeploymentStatus
DeploymentStatus is the most recently observed status of the Deployment.
DeploymentStrategy
DeploymentStrategy describes how to replace existing pods with new ones.
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.
Endpoint
Endpoint represents a single logical "backend" implementing a service.
EndpointAddress
EndpointAddress is a tuple that describes single IP address.
EndpointConditions
EndpointConditions represents the current condition of an endpoint.
EndpointHints
EndpointHints provides hints describing how an endpoint should be consumed.
EndpointPort
EndpointPort is a tuple that describes a single port.
Endpoints
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} }, ].
EndpointSlice
EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints.
EndpointSliceList
EndpointSliceList represents a list of endpoint slices.
EndpointsList
EndpointsList is a list of endpoints.
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: { 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 .
EnvFromSource
EnvFromSource represents the source of a set of ConfigMaps.
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.
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.
Eviction
Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/
ExecAction
ExecAction describes a "run in container" action.
ExternalDocumentation
ExternalDocumentation allows referencing an external resource for extended documentation.
ExternalMetricSource
ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
ExternalMetricStatus
ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.
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.
FieldsV1
FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
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.
ForZone
ForZone provides information about which zones should consume this endpoint.
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.
GroupVersionForDiscovery
GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.
GRPCAction
HorizontalPodAutoscaler
HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
HorizontalPodAutoscalerBehavior
HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).
HorizontalPodAutoscalerCondition
HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.
HorizontalPodAutoscalerList
HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.
HorizontalPodAutoscalerSpec
HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.
HorizontalPodAutoscalerStatus
HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.
HostAlias
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
HostPathVolumeSource
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
HPAScalingPolicy
HPAScalingPolicy is a single policy which must hold true for a specified past interval.
HPAScalingRules
HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
HTTPGetAction
HTTPGetAction describes an action based on HTTP Get requests.
HTTPHeader
HTTPHeader describes a custom header to be used in HTTP probes.
HTTPIngressPath
HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.
HTTPIngressRuleValue
HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://
Info
Info contains versioning information. how we'll want to distribute that information.
Ingress
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
IngressBackend
IngressBackend describes all endpoints for a given service and port.
IngressClass
IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The ingressclass.kubernetes.io/is-default-class annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.
IngressClassList
IngressClassList is a collection of IngressClasses.
IngressClassParametersReference
IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.
IngressClassSpec
IngressClassSpec provides information about the class of an Ingress.
IngressList
IngressList is a collection of Ingress.
IngressRule
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
IngressServiceBackend
IngressServiceBackend references a Kubernetes Service as a Backend.
IngressSpec
IngressSpec describes the Ingress the user wishes to exist.
IngressStatus
IngressStatus describe the current state of the Ingress.
IngressTLS
IngressTLS describes the transport layer security associated with an Ingress.
IPBlock
IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.
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.
Job
Job represents the configuration of a single job.
JobCondition
JobCondition describes current state of a job.
JobList
JobList is a collection of jobs.
JobSpec
JobSpec describes how the job execution will look like.
JobStatus
JobStatus represents the current state of a Job.
JobTemplateSpec
JobTemplateSpec describes the data a Job should have when created from a template.
JSON
JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, mapstringinterface{} and nil.
JSONSchemaProps
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
JSONSchemaPropsOrArray
JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.
JSONSchemaPropsOrBool
JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
JSONSchemaPropsOrStringArray
JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.
KeyToPath
Maps a string key to a path within a volume.
KubernetesClient
Kubernetes client.
LabelSelector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
LabelSelectorRequirement
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Lease
Lease defines a lease concept.
LeaseList
LeaseList is a list of Lease objects.
LeaseSpec
LeaseSpec is a specification of a Lease.
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.
ListMeta
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
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.
LocalSubjectAccessReview
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
LocalVolumeSource
Local represents directly-attached storage with node affinity (Beta feature).
ManagedFieldsEntry
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
MetricIdentifier
MetricIdentifier defines the name and optionally selector for a metric.
MetricSpec
MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).
MetricStatus
MetricStatus describes the last-read state of a single metric.
MetricTarget
MetricTarget defines the target value, average value, or average utilization of a specific metric.
MetricValueStatus
MetricValueStatus holds the current value for a metric.
MicroTime
MicroTime is version of Time with microsecond level precision.
MutatingWebhook
MutatingWebhook describes an admission webhook and the resources and operations it applies to.
MutatingWebhookConfiguration
MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.
MutatingWebhookConfigurationList
MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.
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.
NetworkPolicy
NetworkPolicy describes what network traffic is allowed for a set of Pods.
NetworkPolicyEgressRule
NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8.
NetworkPolicyIngressRule
NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
NetworkPolicyList
NetworkPolicyList is a list of NetworkPolicy objects.
NetworkPolicyPeer
NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed.
NetworkPolicyPort
NetworkPolicyPort describes a port to allow traffic on.
NetworkPolicySpec
NetworkPolicySpec provides the specification of a NetworkPolicy.
NetworkPolicyStatus
NetworkPolicyStatus describe the current state of the NetworkPolicy.
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.
NodeList
NodeList is the whole list of all Nodes which have been registered with master.
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.
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.
NodeSpec
NodeSpec describes the attributes that a node is created with.
NodeStatus
NodeStatus is information about the current status of a node.
NodeSystemInfo
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
NonResourceAttributes
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface.
NonResourceRule
NonResourceRule holds information that describes a rule for the non-resource.
ObjectFieldSelector
ObjectFieldSelector selects an APIVersioned field of an object.
ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
ObjectMetricSource
ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
ObjectMetricStatus
ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).
ObjectReference
ObjectReference contains enough information to let you inspect or modify the referred object.
Overhead
Overhead structure represents the resource overhead associated with running a pod.
OwnerReference
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
Patch
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
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 contails 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.
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
PodAntiAffinity
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
PodCondition
PodCondition contains details for the current condition of this pod.
PodDisruptionBudget
PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods.
PodDisruptionBudgetList
PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
PodDisruptionBudgetSpec
PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
PodDisruptionBudgetStatus
PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.
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.
PodIP
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.
PodList
PodList is a list of Pods.
PodOS
PodOS defines the OS parameters of a pod.
PodReadinessGate
PodReadinessGate contains the reference to a pod condition.
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.
PodsMetricSource
PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
PodsMetricStatus
PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
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.
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.
PolicyRule
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
PortStatus
PortworxVolumeSource
PortworxVolumeSource represents a Portworx volume resource.
Preconditions
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
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).
PriorityClass
PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.
PriorityClassList
PriorityClassList is a collection of priority classes.
Probe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
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.
RawExtension
RawExtension is used to hold extensions in external versions.
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.
ReplicaSet
ReplicaSet ensures that a specified number of pod replicas are running at any given time.
ReplicaSetCondition
ReplicaSetCondition describes the state of a replica set at a certain point.
ReplicaSetList
ReplicaSetList is a collection of ReplicaSets.
ReplicaSetSpec
ReplicaSetSpec is the specification of a ReplicaSet.
ReplicaSetStatus
ReplicaSetStatus represents the current status of a ReplicaSet.
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.
ResourceAttributes
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface.
ResourceFieldSelector
ResourceFieldSelector represents container resources (cpu, memory) and their output format.
ResourceMetricSource
ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.
ResourceMetricStatus
ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
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.
ResourceRule
ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
Role
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
RoleBinding
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
RoleBindingList
RoleBindingList is a collection of RoleBindings.
RoleList
RoleList is a collection of Roles.
RoleRef
RoleRef contains information that points to the role being used.
RollingUpdateDaemonSet
Spec to control the desired behavior of daemon set rolling update.
RollingUpdateDeployment
Spec to control the desired behavior of rolling update.
RollingUpdateStatefulSetStrategy
RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
RuleWithOperations
RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.
RuntimeClass
RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/.
RuntimeClassList
RuntimeClassList is a list of RuntimeClass objects.
ScaleIOPersistentVolumeSource
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume.
ScaleIOVolumeSource
ScaleIOVolumeSource represents a persistent ScaleIO volume.
Scheduling
Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.
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.
ScopeSelector
A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
SeccompProfile
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
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.
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.
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.
SelfSubjectAccessReview
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action.
SelfSubjectAccessReviewSpec
SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set.
SelfSubjectRulesReview
SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.
SelfSubjectRulesReviewSpec
SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.
SELinuxOptions
SELinuxOptions are the labels to be applied to the container.
ServerAddressByClientCIDR
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
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: * 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
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).
ServiceBackendPort
ServiceBackendPort is the service port being referenced.
ServiceList
ServiceList holds a list of services.
ServicePort
ServicePort contains information on service's port.
ServiceReference
ServiceReference holds a reference to Service.legacy.k8s.io.
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.
StatefulSet
StatefulSet represents a set of pods with consistent identities. Identities are defined as:
StatefulSetCondition
StatefulSetCondition describes the state of a statefulset at a certain point.
StatefulSetList
StatefulSetList is a collection of StatefulSets.
StatefulSetPersistentVolumeClaimRetentionPolicy
StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.
StatefulSetSpec
A StatefulSetSpec is the specification of a StatefulSet.
StatefulSetStatus
StatefulSetStatus represents the current state of a StatefulSet.
StatefulSetUpdateStrategy
StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.
Status
Status is a return value for calls that don't return other objects.
StatusCause
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
StatusDetails
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
StorageClass
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
StorageClassList
StorageClassList is a collection of storage classes.
StorageOSPersistentVolumeSource
Represents a StorageOS persistent volume resource.
StorageOSVolumeSource
Represents a StorageOS persistent volume resource.
Subject
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
SubjectAccessReview
SubjectAccessReview checks whether or not a user or group can perform an action.
SubjectAccessReviewSpec
SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set.
SubjectAccessReviewStatus
SubjectAccessReviewStatus.
SubjectRulesReviewStatus
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
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.
TokenRequest
TokenRequest requests a token for a given service account.
TokenRequestSpec
TokenRequestSpec contains client provided parameters of a token request.
TokenRequestStatus
TokenRequestStatus is the result of a token request.
TokenReview
TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.
TokenReviewSpec
TokenReviewSpec is a description of the token authentication request.
TokenReviewStatus
TokenReviewStatus is the result of the token authentication request.
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.
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.
UncountedTerminatedPods
UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.
UserInfo
UserInfo holds the information about the user needed to implement the user.Info interface.
ValidatingWebhook
ValidatingWebhook describes an admission webhook and the resources and operations it applies to.
ValidatingWebhookConfiguration
ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.
ValidatingWebhookConfigurationList
ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.
ValidationRule
ValidationRule describes a validation rule written in the CEL expression language.
Volume
Volume represents a named volume in a pod that may be accessed by any container in the pod.
VolumeAttachment
VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.
VolumeAttachmentList
VolumeAttachmentList is a collection of VolumeAttachment objects.
VolumeAttachmentSource
VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.
VolumeAttachmentSpec
VolumeAttachmentSpec is the specification of a VolumeAttachment request.
VolumeAttachmentStatus
VolumeAttachmentStatus is the status of a VolumeAttachment request.
VolumeDevice
VolumeDevice describes a mapping of a raw block device within a container.
VolumeError
VolumeError captures an error encountered during a volume operation.
VolumeMount
VolumeMount describes a mounting of a Volume within a container.
VolumeNodeAffinity
VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
VolumeNodeResources
VolumeNodeResources is a set of resource limits for scheduling of volumes.
VolumeProjection
Projection that may be projected along with other supported volume types.
VsphereVirtualDiskVolumeSource
Represents a vSphere volume resource.
WatchEvent
Event represents a single event to a watched resource.
WebhookClientConfig
WebhookClientConfig contains the information to make a TLS connection with the webhook.
WebhookConversion
WebhookConversion describes how to call a conversion webhook.
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.

Enums

PatchType