Kazan v0.1.0 API Reference
Modules
Kazan is a Kubernetes API client for Elixir
Contains generated API modules as defined in the OAI specs
Contains functions for the Apis API
Contains functions for the Apps API
Contains functions for the AppsV1beta1 API
Contains functions for the Authentication API
Contains functions for the AuthenticationV1beta1 API
Contains functions for the Authorization API
Contains functions for the AuthorizationV1beta1 API
Contains functions for the Autoscaling API
Contains functions for the AutoscalingV1 API
Contains functions for the Batch API
Contains functions for the BatchV1 API
Contains functions for the BatchV2alpha1 API
Contains functions for the Certificates API
Contains functions for the CertificatesV1alpha1 API
Contains functions for the Core API
Contains functions for the CoreV1 API
Contains functions for the Extensions API
Contains functions for the ExtensionsV1beta1 API
Contains functions for the Logs API
Contains functions for the Policy API
Contains functions for the PolicyV1beta1 API
Contains functions for the RbacAuthorization API
Contains functions for the RbacAuthorizationV1alpha1 API
Contains functions for the Storage API
Contains functions for the StorageV1beta1 API
Contains functions for the Version API
Kazan.Client sends requests to a kubernetes server
Contains generated structs for all Kube models as defined in the OAI specs
RawExtension is used to hold extensions in external versions
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
GroupVersion contains the “group/version” and “version” string of a version. It is made a struct to keep extensibility
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}
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
AttachedVolume describes a volume attached to a node
Binding ties one object to another. For example, a pod is bound to a node by a scheduler
Adds and removes POSIX capabilities from running containers
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
Selects a key from a ConfigMap
ConfigMapList is a resource containing a list of ConfigMap objects
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
CrossVersionObjectReference contains enough information to let you identify the referred resource
DaemonEndpoint contains information about a single Daemon endpoint
DeleteOptions may be provided when deleting an API object
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
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
EventSource contains information for an event
ExecAction describes a “run in container” action
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
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
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
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
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
NodeCondition contains condition information for a node
NodeDaemonEndpoints lists ports opened by daemons running on the Node
NodeList is the whole list of all Nodes which have been registered with master
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
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create
ObjectReference contains enough information to let you inspect or modify the referred object
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
PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes
PersistentVolumeClaim is a user’s request for and claim to a persistent volume
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
PersistentVolumeList is a list of PersistentVolume items
PersistentVolumeSpec is the specification of a persistent volume
PersistentVolumeStatus is the current status of a persistent volume
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts
PodCondition contains details for the current condition of this pod
PodList is a list of Pods
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
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
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic
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
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
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes
SecretKeySelector selects a key of a Secret
SecretList is a list of Secret
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
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
TCPSocketAction describes an action based on opening a socket
Volume represents a named volume in a pod that may be accessed by any container in the pod
VolumeMount describes a mounting of a Volume within a container
Describes a certificate signing request
This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users
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
An APIVersion represents a single concrete version of an object model
DaemonSet represents the configuration of a daemon set
DaemonSetList is a collection of daemon sets
DaemonSetSpec is the specification of a daemon set
DaemonSetStatus represents the current status of a daemon set
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
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
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/
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
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
Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead
JobCondition describes current state of a job
JobList is a collection of jobs. DEPRECATED: extensions/v1beta1.JobList is deprecated, use batch/v1.JobList instead
JobSpec describes how the job execution will look like
JobStatus represents the current state of a Job
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
This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from
Network Policy List is a list of NetworkPolicy objects
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
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
ReplicaSet represents the configuration of a ReplicaSet
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
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
Spec to control the desired behavior of rolling update
represents a scaling request for a resource
describes the attributes of a scale subresource
represents the current status of a scale subresource
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
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
StatefulSetList is a collection of StatefulSets
A StatefulSetSpec is the specification of a StatefulSet
StatefulSetStatus represents the current state of a StatefulSet
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned
StorageClassList is a collection of storage classes
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
SubjectAccessReviewStatus
SubresourceReference contains enough information to let you inspect or modify the referred subresource
A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api
ThirdPartyResourceList is a list of ThirdPartyResources
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
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
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
JobTemplateSpec describes the data a Job should have when created from a template
Info contains versioning information. how we’ll want to distribute that information
Event represents a single event to a watched resource
Kazan.Request is a struct that describes an HTTP request
Kazan.Server is a struct containing connection details for a kube server
Exceptions
Raised when we get an error from a Kube server
Raised when we get an error from a Kube server