Kazan v0.10.0 API Reference

Modules

Kazan is a Kubernetes API client for Elixir

Contains generated API modules as defined in the OAI specs

Module for the Admissionregistration API group

Contains functions for V1alpha1 of the Admissionregistration API group

Initializer describes the name and the failure policy of an initializer, and what resources it applies to

InitializerConfiguration describes the configuration of initializers

InitializerConfigurationList is a list of InitializerConfiguration

Rule is a tuple of APIGroups, APIVersion, and Resources.It is recommended to make sure that all the tuple expansions are valid

Contains functions for V1beta1 of the Admissionregistration API group

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object

MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration

RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid

ServiceReference holds a reference to Service.legacy.k8s.io

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it

ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration

Webhook describes an admission webhook and the resources and operations it applies to

WebhookClientConfig contains the information to make a TLS connection with the webhook

Module for the Apiextensions API group

Contains functions for V1beta1 of the Apiextensions API group

Module for the Apiregistration API group

Contains functions for V1 of the Apiregistration API group

Contains functions for V1beta1 of the Apiregistration API group

Module for the Apis API group

Module for the Apps API group

Contains functions for V1 of the Apps API group

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 is a resource containing a list of ControllerRevision objects

DaemonSet represents the configuration of a daemon set

DaemonSetCondition describes the state of a DaemonSet at a certain point

DaemonSetList is a collection of daemon sets

DaemonSetSpec is the specification of a daemon set

DaemonSetStatus represents the current status of a daemon set

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet

Deployment enables declarative updates for Pods and ReplicaSets

DeploymentCondition describes the state of a deployment at a certain point

DeploymentList is a list of Deployments

DeploymentSpec is the specification of the desired behavior of the Deployment

DeploymentStatus is the most recently observed status of the Deployment

DeploymentStrategy describes how to replace existing pods with new ones

ReplicaSet ensures that a specified number of pod replicas are running at any given time

ReplicaSetCondition describes the state of a replica set at a certain point

ReplicaSetList is a collection of ReplicaSets

ReplicaSetSpec is the specification of a ReplicaSet

ReplicaSetStatus represents the current status of a ReplicaSet

Spec to control the desired behavior of daemon set rolling update

Spec to control the desired behavior of rolling update

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

  • Network: A single stable DNS and hostname.
  • Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity

StatefulSetCondition describes the state of a statefulset at a certain point

StatefulSetList is a collection of StatefulSets

A StatefulSetSpec is the specification of a StatefulSet

StatefulSetStatus represents the current state of a StatefulSet

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

Contains functions for V1beta1 of the Apps API group

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. 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 is a resource containing a list of ControllerRevision objects

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets

DeploymentCondition describes the state of a deployment at a certain point

DeploymentList is a list of Deployments

DEPRECATED. DeploymentRollback stores the information required to rollback a deployment

DeploymentSpec is the specification of the desired behavior of the Deployment

DeploymentStatus is the most recently observed status of the Deployment

DeploymentStrategy describes how to replace existing pods with new ones

Spec to control the desired behavior of rolling update

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType

Scale represents a scaling request for a resource

ScaleSpec describes the attributes of a scale subresource

ScaleStatus represents the current status of a scale subresource

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

  • Network: A single stable DNS and hostname.
  • Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity

StatefulSetCondition describes the state of a statefulset at a certain point

StatefulSetList is a collection of StatefulSets

A StatefulSetSpec is the specification of a StatefulSet

StatefulSetStatus represents the current state of a StatefulSet

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

Contains functions for V1beta2 of the Apps API group

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1/ControllerRevision. See the release notes for more information. 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 is a resource containing a list of ControllerRevision objects

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set

DaemonSetCondition describes the state of a DaemonSet at a certain point

DaemonSetList is a collection of daemon sets

DaemonSetSpec is the specification of a daemon set

DaemonSetStatus represents the current status of a daemon set

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet

DEPRECATED - This group version of Deployment is deprecated by apps/v1/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets

DeploymentCondition describes the state of a deployment at a certain point

DeploymentList is a list of Deployments

DeploymentSpec is the specification of the desired behavior of the Deployment

DeploymentStatus is the most recently observed status of the Deployment

DeploymentStrategy describes how to replace existing pods with new ones

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time

ReplicaSetCondition describes the state of a replica set at a certain point

ReplicaSetList is a collection of ReplicaSets

ReplicaSetSpec is the specification of a ReplicaSet

ReplicaSetStatus represents the current status of a ReplicaSet

Spec to control the desired behavior of daemon set rolling update

Spec to control the desired behavior of rolling update

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType

Scale represents a scaling request for a resource

ScaleSpec describes the attributes of a scale subresource

ScaleStatus represents the current status of a scale subresource

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

  • Network: A single stable DNS and hostname.
  • Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity

StatefulSetCondition describes the state of a statefulset at a certain point

StatefulSetList is a collection of StatefulSets

A StatefulSetSpec is the specification of a StatefulSet

StatefulSetStatus represents the current state of a StatefulSet

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

Module for the Authentication API group

Contains functions for V1 of the Authentication API group

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 is a description of the token authentication request

TokenReviewStatus is the result of the token authentication request

UserInfo holds the information about the user needed to implement the user.Info interface

Contains functions for V1beta1 of the Authentication API group

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 is a description of the token authentication request

TokenReviewStatus is the result of the token authentication request

UserInfo holds the information about the user needed to implement the user.Info interface

Module for the Authorization API group

Contains functions for V1 of the Authorization API group

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

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

NonResourceRule holds information that describes a rule for the non-resource

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

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

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 is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

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

SubjectAccessReview checks whether or not a user or group can perform an action

SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

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

Contains functions for V1beta1 of the Authorization API group

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

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

NonResourceRule holds information that describes a rule for the non-resource

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

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

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 is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

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

SubjectAccessReview checks whether or not a user or group can perform an action

SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

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

Module for the Autoscaling API group

Contains functions for V1 of the Autoscaling API group

CrossVersionObjectReference contains enough information to let you identify the referred resource

configuration of a horizontal pod autoscaler

list of horizontal pod autoscaler objects

specification of a horizontal pod autoscaler

current status of a horizontal pod autoscaler

Scale represents a scaling request for a resource

ScaleSpec describes the attributes of a scale subresource

ScaleStatus represents the current status of a scale subresource

Contains functions for V2beta1 of the Autoscaling API group

CrossVersionObjectReference contains enough information to let you identify the referred resource

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). Exactly one “target” type should be set

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object

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

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point

HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once)

MetricStatus describes the last-read state of a single metric

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object)

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object)

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 indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second)

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 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

Module for the Batch API group

Contains functions for V1 of the Batch API group

Job represents the configuration of a single job

JobCondition describes current state of a job

JobList is a collection of jobs

JobSpec describes how the job execution will look like

JobStatus represents the current state of a Job

Contains functions for V1beta1 of the Batch API group

CronJob represents the configuration of a single cron job

CronJobList is a collection of cron jobs

CronJobSpec describes how the job execution will look like and when it will actually run

CronJobStatus represents the current state of a cron job

JobTemplateSpec describes the data a Job should have when created from a template

Contains functions for V2alpha1 of the Batch API group

CronJob represents the configuration of a single cron job

CronJobList is a collection of cron jobs

CronJobSpec describes how the job execution will look like and when it will actually run

CronJobStatus represents the current state of a cron job

JobTemplateSpec describes the data a Job should have when created from a template

Module for the Certificates API group

Contains functions for V1beta1 of the Certificates API group

Describes a certificate signing request

This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users

Module for the Core API group

Contains functions for V1 of the Core API group

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)

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

Status of all the conditions for the component as a list of ComponentStatus objects

ConfigMap holds configuration data for pods to consume

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with

Selects a key from a ConfigMap

ConfigMapList is a resource containing a list of ConfigMap objects

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node

Adapts a ConfigMap into a projected volume

Adapts a ConfigMap into a volume

A single application container that you want to run within a pod

Describe a container image

ContainerPort represents a network port in a single container

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}]
},

]

EndpointsList is a list of endpoints

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

Event is a report of an event somewhere in the cluster

EventList is a list of events

EventSeries contain information on series of events, i.e. 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

HTTPGetAction describes an action based on HTTP Get requests

HTTPHeader describes a custom header to be used in HTTP probes

Handler defines a specific action that should be taken

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

LimitRange sets resource usage limits for each kind of resource in a Namespace

LimitRangeItem defines a min/max usage limit for any resource that matches on kind

LimitRangeList is a list of LimitRange items

LimitRangeSpec defines a min/max usage limit for resources that match on kind

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

NamespaceList is a list of Namespaces

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

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource

NodeDaemonEndpoints lists ports opened by daemons running on the Node

NodeList is the whole list of all Nodes which have been registered with master

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

PersistentVolumeClaimList is a list of PersistentVolumeClaim items

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

PersistentVolumeClaimStatus is the current status of a persistent volume claim

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 is a list of PersistentVolume items

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 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

PodList is a list of Pods

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

PodTemplateList is a list of PodTemplates

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

ReplicationController represents the configuration of a replication controller

ReplicationControllerCondition describes the state of a replication controller at a certain point

ReplicationControllerList is a collection of replication controllers

ReplicationControllerSpec is the specification of a replication controller

ReplicationControllerStatus represents the current status of a replication controller

ResourceFieldSelector represents container resources (cpu, memory) and their output format

ResourceQuota sets aggregate quota restrictions enforced per namespace

ResourceQuotaList is a list of ResourceQuota items

ResourceQuotaSpec defines the desired hard limits to enforce for Quota

ResourceQuotaStatus defines the enforced hard limits and observed use

ResourceRequirements describes the compute resource requirements

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

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

SecretList is a list of 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

ServiceAccountList is a list of ServiceAccount objects

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 holds a list of services

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 using the matching 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

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)

Module for the Events API group

Contains functions for V1beta1 of the Events API group

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system

EventList is a list of Event objects

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time

Module for the Extensions API group

Contains functions for V1beta1 of the Extensions API group

AllowedFlexVolume represents a single Flexvolume that is allowed to be used. Deprecated: use AllowedFlexVolume from policy API Group instead

AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined. Deprecated: use AllowedHostPath from policy API Group instead

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set

DaemonSetCondition describes the state of a DaemonSet at a certain point

DaemonSetList is a collection of daemon sets

DaemonSetSpec is the specification of a daemon set

DaemonSetStatus represents the current status of a daemon set

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets

DeploymentCondition describes the state of a deployment at a certain point

DeploymentList is a list of Deployments

DEPRECATED. DeploymentRollback stores the information required to rollback a deployment

DeploymentSpec is the specification of the desired behavior of the Deployment

DeploymentStatus is the most recently observed status of the Deployment

DeploymentStrategy describes how to replace existing pods with new ones

FSGroupStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use FSGroupStrategyOptions from policy API Group instead

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last ‘/‘ and before the first ‘?’ or ‘#’

HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined. Deprecated: use HostPortRange from policy API Group instead

IDRange provides a min/max of an allowed range of IDs. Deprecated: use IDRange from policy API Group instead

DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. “192.168.1.1/24”) 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

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 describes all endpoints for a given service and port

IngressList is a collection of Ingress

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

IngressSpec describes the Ingress the user wishes to exist

IngressStatus describe the current state of the Ingress

IngressTLS describes the transport layer security associated with an Ingress

DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods

DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/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

DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from

DEPRECATED 1.9 - This group version of NetworkPolicyList is deprecated by networking/v1/NetworkPolicyList. Network Policy List is a list of NetworkPolicy objects

DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer

DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort

DEPRECATED 1.9 - This group version of NetworkPolicySpec is deprecated by networking/v1/NetworkPolicySpec

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated: use PodSecurityPolicy from policy API Group instead

PodSecurityPolicyList is a list of PodSecurityPolicy objects. Deprecated: use PodSecurityPolicyList from policy API Group instead

PodSecurityPolicySpec defines the policy enforced. Deprecated: use PodSecurityPolicySpec from policy API Group instead

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time

ReplicaSetCondition describes the state of a replica set at a certain point

ReplicaSetList is a collection of ReplicaSets

ReplicaSetSpec is the specification of a ReplicaSet

ReplicaSetStatus represents the current status of a ReplicaSet

Spec to control the desired behavior of daemon set rolling update

Spec to control the desired behavior of rolling update

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use RunAsUserStrategyOptions from policy API Group instead

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use SELinuxStrategyOptions from policy API Group instead

represents a scaling request for a resource

describes the attributes of a scale subresource

represents the current status of a scale subresource

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use SupplementalGroupsStrategyOptions from policy API Group instead

Module for the Logs API group

Module for the Networking API group

Contains functions for V1 of the Networking API group

IPBlock describes a particular CIDR (Ex. “192.168.1.1/24”) 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

NetworkPolicy describes what network traffic is allowed for a set of Pods

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 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 is a list of NetworkPolicy objects

NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed

NetworkPolicyPort describes a port to allow traffic on

NetworkPolicySpec provides the specification of a NetworkPolicy

Module for the Policy API group

Contains functions for V1beta1 of the Policy API group

AllowedFlexVolume represents a single Flexvolume that is allowed to be used

AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined

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//evictions

FSGroupStrategyOptions defines the strategy type and options used to create the strategy

HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined

IDRange provides a min/max of an allowed range of IDs

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

PodDisruptionBudgetList is a collection of PodDisruptionBudgets

PodDisruptionBudgetSpec is a description of a PodDisruptionBudget

PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container

PodSecurityPolicyList is a list of PodSecurityPolicy objects

PodSecurityPolicySpec defines the policy enforced

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or 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 is a collection of ClusterRoleBindings

ClusterRoleList is a collection of ClusterRoles

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

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a 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 is a collection of RoleBindings

RoleList is a collection of Roles

RoleRef contains information that points to the role being used

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

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or 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 is a collection of ClusterRoleBindings

ClusterRoleList is a collection of ClusterRoles

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

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a 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 is a collection of RoleBindings

RoleList is a collection of Roles

RoleRef contains information that points to the role being used

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

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or 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 is a collection of ClusterRoleBindings

ClusterRoleList is a collection of ClusterRoles

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

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a 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 is a collection of RoleBindings

RoleList is a collection of Roles

RoleRef contains information that points to the role being used

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

Module for the Rbacauthorization API group

Contains functions for V1 of the Rbacauthorization API group

Contains functions for V1alpha1 of the Rbacauthorization API group

Contains functions for V1beta1 of the Rbacauthorization API group

Module for the Scheduling API group

Contains functions for V1alpha1 of the Scheduling API group

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer

PriorityClassList is a collection of priority classes

Contains functions for V1beta1 of the Scheduling API group

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer

PriorityClassList is a collection of priority classes

Module for the Settings API group

Contains functions for V1alpha1 of the Settings API group

PodPreset is a policy resource that defines additional runtime requirements for a Pod

PodPresetList is a list of PodPreset objects

PodPresetSpec is a description of a pod preset

Module for the Storage API group

Contains functions for V1 of the Storage API group

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned

StorageClassList is a collection of storage classes

Contains functions for V1alpha1 of the Storage API group

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node

VolumeAttachmentList is a collection of VolumeAttachment objects

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 is the specification of a VolumeAttachment request

VolumeAttachmentStatus is the status of a VolumeAttachment request

VolumeError captures an error encountered during a volume operation

Contains functions for V1beta1 of the Storage API group

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned

StorageClassList is a collection of storage classes

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node

VolumeAttachmentList is a collection of VolumeAttachment objects

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 is the specification of a VolumeAttachment request

VolumeAttachmentStatus is the status of a VolumeAttachment request

VolumeError captures an error encountered during a volume operation

Module for the Version API group

DEPRECATED: This module will become private API and/or removed in the future. Use the Kazan module instead

Contains structs for all k8s models that don’t belong to a specific API group

CustomResourceColumnDefinition specifies a column for server side printing

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>

CustomResourceDefinitionCondition contains details for the current condition of this pod

CustomResourceDefinitionList is a list of CustomResourceDefinition objects

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

CustomResourceDefinitionSpec describes how a user wants their resource to appear

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources

CustomResourceSubresources defines the status and scale subresources for CustomResources

CustomResourceValidation is a list of validation methods for CustomResources

ExternalDocumentation allows referencing an external resource for extended documentation

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/)

APIGroup contains the name, the supported versions, and the preferred version of a group

APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis

APIResource specifies the name of a resource and whether it is namespaced

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

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

DeleteOptions may be provided when deleting an API object

GroupVersion contains the “group/version” and “version” string of a version. It is made a struct to keep extensibility

Initializer is information about an initializer that has not yet completed

Initializers tracks the progress of initialization

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

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match

Status is a return value for calls that don’t return other objects

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered

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

Event represents a single event to a watched resource

RawExtension is used to hold extensions in external versions

Info contains versioning information. how we’ll want to distribute that information

APIService represents a server for a particular GroupVersion. Name must be “version.group”

APIServiceList is a list of APIService objects

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification

APIServiceStatus contains derived information about an API server

ServiceReference holds a reference to Service.legacy.k8s.io

APIService represents a server for a particular GroupVersion. Name must be “version.group”

APIServiceList is a list of APIService objects

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification

APIServiceStatus contains derived information about an API server

ServiceReference holds a reference to Service.legacy.k8s.io

Kazan.Request is a struct that describes an HTTP request

Kazan.Server is a struct containing connection details for a kube server

This struct stores details of how to auth with an auth provider

Watches for changes on a resource. This works by creating a HTTPoison ASync request. The request will eventually timeout, however the Watcher handles recreating the request when this occurs and requesting new events that have occurred since the last resource_version received

Exceptions

Raised when we get an error from a Kube server

Raised when we get an error from a Kube server