- example

# WORKLOADS

Workloads resources are responsible for managing and running your containers on the cluster. Containers are created by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or persistent storage Volumes and Configuration or Secret data injected into the container.

The most common Controllers are:

- Deployments for stateless persistent apps (e.g. http servers)
- StatefulSets for stateful persistent apps (e.g. databases)
- Jobs for run-to-completion apps (e.g. batch jobs).

# Container v1

> Container Config to run nginx (must be embedded in a PodSpec to run).

    name: nginx
    # Run the nginx:1.10 image
    image: nginx:1.10

Group | Version | Kind
--- | --- | ---
Core | v1 | Container

Containers are only ever created within the context of a Pod. This is usually done using a Controller. See Controllers: Deployment, Job, or StatefulSet

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

Appears In PodSpec

Field | Description
--- | ---

args
string array

Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

command
string array

Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

env EnvVar array | List of environment variables to set in the container. Cannot be updated.
image string | Docker image name. More info: http://kubernetes.io/docs/user-guide/images
imagePullPolicy string | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images
lifecycle Lifecycle | Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe Probe | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
name string | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

ports
ContainerPort array

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

readinessProbe Probe | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
resources ResourceRequirements | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#resources
securityContext SecurityContext | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
stdin boolean | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

stdinOnce
boolean

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

terminationMessagePath string | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.
tty boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeMounts VolumeMount array | Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDir string | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

### ContainerStatus v1

Appears In PodStatus

Field | Description
--- | ---
containerID string | Container's ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
image string | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
imageID string | ImageID of the container's image.
lastState ContainerState | Details about the container's last termination condition.
name string | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
ready boolean | Specifies whether the container has passed its readiness probe.
restartCount integer | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
state ContainerState | Details about the container's current condition.

# CronJob v2alpha1

Group | Version | Kind
--- | --- | ---
Batch | v2alpha1 | CronJob

Alpha objects should not be used in production and may not be compatible with future versions of the resource type.

CronJob represents the configuration of a single cron job.

Appears In CronJobList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec CronJobSpec | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status CronJobStatus | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### CronJobSpec v2alpha1

Appears In CronJob

Field | Description
--- | ---
concurrencyPolicy string | ConcurrencyPolicy specifies how to treat concurrent executions of a Job.
jobTemplate JobTemplateSpec | JobTemplate is the object that describes the job that will be created when executing a CronJob.
schedule string | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
startingDeadlineSeconds integer | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
suspend boolean | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

### CronJobStatus v2alpha1

Appears In CronJob

Field | Description
--- | ---
active ObjectReference array | Active holds pointers to currently running jobs.
lastScheduleTime Time | LastScheduleTime keeps information of when was the last time the job was successfully scheduled.

### CronJobList v2alpha1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items CronJob array | Items is the list of CronJob.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# DaemonSet v1beta1

> DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.

    apiVersion: extensions/v1beta1
    kind: DaemonSet
    metadata:
      # Unique key of the DaemonSet instance
      name: daemonset-example
    spec:
      template:
        metadata:
          labels:
            app: daemonset-example
        spec:
          containers:
          # This container is run once on each Node in the cluster
          - name: daemonset-example
            image: ubuntu:trusty
            command:
            - /bin/sh
            args:
            - -c
            # This script is run through `sh -c <script>`
            - >-
              while [ true ]; do
              echo "DaemonSet running on $(hostname)" ;
              sleep 10 ;
              done

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | DaemonSet

DaemonSet represents the configuration of a daemon set.

Appears In DaemonSetList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec DaemonSetSpec | Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status DaemonSetStatus | Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### DaemonSetSpec v1beta1

Appears In DaemonSet

Field | Description
--- | ---
selector LabelSelector | Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template PodTemplateSpec | Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

### DaemonSetStatus v1beta1

Appears In DaemonSet

Field | Description
--- | ---
currentNumberScheduled integer | CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
desiredNumberScheduled integer | DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
numberMisscheduled integer | NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
numberReady integer | NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

### DaemonSetList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items DaemonSet array | Items is a list of daemon sets.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# Deployment v1beta1

> Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).

    apiVersion: extensions/v1beta1
    kind: Deployment
    metadata:
      # Unique key of the Deployment instance
      name: deployment-example
    spec:
      # 3 Pods should exist at all times.
      replicas: 3
      # Keep record of 2 revisions for rollback
      revisionHistoryLimit: 2
      template:
        metadata:
          labels:
            # Apply this label to pods and default
            # the Deployment label selector to this value
            app: nginx
        spec:
          containers:
          - name: nginx
            # Run this image
            image: nginx:1.10

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | Deployment

Deployment enables declarative updates for Pods and ReplicaSets.

Appears In DeploymentList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object metadata.
spec DeploymentSpec | Specification of the desired behavior of the Deployment.
status DeploymentStatus | Most recently observed status of the Deployment.

### DeploymentSpec v1beta1

Appears In Deployment

Field | Description
--- | ---
minReadySeconds integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused boolean | Indicates that the deployment is paused and will not be processed by the deployment controller.

progressDeadlineSeconds
integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.

replicas integer | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit integer | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
rollbackTo RollbackConfig | The config this deployment is rolling back to. Will be cleared after rollback is done.
selector LabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
strategy DeploymentStrategy | The deployment strategy to use to replace existing pods with new ones.
template PodTemplateSpec | Template describes the pods that will be created.

### DeploymentStatus v1beta1

Appears In Deployment

Field | Description
--- | ---
availableReplicas integer | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
conditions DeploymentCondition array | Represents the latest available observations of a deployment's current state.
observedGeneration integer | The generation observed by the deployment controller.
replicas integer | Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas integer | Total number of unavailable pods targeted by this deployment.
updatedReplicas integer | Total number of non-terminated pods targeted by this deployment that have the desired template spec.

### DeploymentList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Deployment array | Items is the list of Deployments.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata.

### DeploymentStrategy v1beta1

Appears In DeploymentSpec

Field | Description
--- | ---
rollingUpdate RollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type string | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

### DeploymentRollback v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
name string | Required: This must match the Name of a deployment.
rollbackTo RollbackConfig | The config of this deployment rollback.
updatedAnnotations object | The annotations to be updated to a deployment

### RollingUpdateDeployment v1beta1

Appears In DeploymentStrategy

Field | Description
--- | ---

maxSurge
IntOrString

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.

maxUnavailable
IntOrString

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

# Job v1

> Job Config to print pi up to 2000 digits (then exit).

    apiVersion: batch/v1
    kind: Job
    metadata:
      # Unique key of the Job instance
      name: example-job
    spec:
      template:
        metadata:
          name: example-job
        spec:
          containers:
          - name: pi
            image: perl
            command: ["perl"]
            args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
          # Do not restart containers after they exit
          restartPolicy: Never

Group | Version | Kind
--- | --- | ---
Batch | v1 | Job

Other api versions of this object exist: v1beta1 v2alpha1

Job represents the configuration of a single job.

Appears In JobList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec JobSpec | Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status JobStatus | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### JobSpec v1

Appears In Job

Field | Description
--- | ---
activeDeadlineSeconds integer | Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

completions
integer

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs

manualSelector
boolean

ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md

parallelism integer | Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs
selector LabelSelector | Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template PodTemplateSpec | Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs

### JobStatus v1

Appears In Job

Field | Description
--- | ---
active integer | Active is the number of actively running pods.
completionTime Time | CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
conditions JobCondition array | Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs
failed integer | Failed is the number of pods which reached Phase Failed.
startTime Time | StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
succeeded integer | Succeeded is the number of pods which reached Phase Succeeded.

### JobList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Job array | Items is the list of Job.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# Pod v1

> Pod Config to print "Hello World".

    apiVersion: v1
    kind: Pod
    metadata:
      name: pod-example
    spec:
      containers:
      - image: ubuntu:trusty
        command: ["echo"]
        args: ["Hello World"]

Group | Version | Kind
--- | --- | ---
Core | v1 | Pod

It is recommended that users create Pods only through a Controller, and not directly. See Controllers: Deployment, Job, or StatefulSet.

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

Appears In PodList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec PodSpec | Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status PodStatus | Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### PodSpec v1

Appears In Pod PodTemplateSpec

Field | Description
--- | ---
activeDeadlineSeconds integer | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
containers Container array | List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers
dnsPolicy string | Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst".
hostIPC boolean | Use the host's ipc namespace. Optional: Default to false.
hostNetwork boolean | Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
hostPID boolean | Use the host's pid namespace. Optional: Default to false.
hostname string | Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

imagePullSecrets
LocalObjectReference array

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

nodeName string | NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
nodeSelector object | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection
restartPolicy string | Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy
securityContext PodSecurityContext | SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
serviceAccount string | DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
serviceAccountName string | ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md
subdomain string | If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

terminationGracePeriodSeconds
integer

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

volumes Volume array | List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

### PodStatus v1

Appears In Pod

Field | Description
--- | ---
conditions PodCondition array | Current service state of pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions
containerStatuses ContainerStatus array | The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses
hostIP string | IP address of the host to which the pod is assigned. Empty if not yet scheduled.
message string | A human readable message indicating details about why the pod is in this condition.
phase string | Current condition of the pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase
podIP string | IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
reason string | A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk'
startTime Time | RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

### PodList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Pod array | List of pods. More info: http://kubernetes.io/docs/user-guide/pods
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# ReplicaSet v1beta1

> ReplicaSet Config to run 3 nginx instances.

    apiVersion: extensions/v1beta1
    kind: ReplicaSet
    metadata:
      # Unique key of the ReplicaSet instance
      name: replicaset-example
    spec:
      # 3 Pods should exist at all times.
      replicas: 3
      template:
        metadata:
          labels:
            app: nginx
        spec:
          containers:
          # Run the nginx image
          - name: nginx
            image: nginx:1.10

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | ReplicaSet

In many cases it is recommended to create a Deployment instead of ReplicaSet.

ReplicaSet represents the configuration of a ReplicaSet.

Appears In ReplicaSetList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec ReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status ReplicaSetStatus | Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### ReplicaSetSpec v1beta1

Appears In ReplicaSet

Field | Description
--- | ---
minReadySeconds integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas integer | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller
selector LabelSelector | Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template PodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

### ReplicaSetStatus v1beta1

Appears In ReplicaSet

Field | Description
--- | ---
availableReplicas integer | The number of available replicas (ready for at least minReadySeconds) for this replica set.
conditions ReplicaSetCondition array | Represents the latest available observations of a replica set's current state.
fullyLabeledReplicas integer | The number of pods that have labels matching the labels of the pod template of the replicaset.
observedGeneration integer | ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
readyReplicas integer | The number of ready replicas for this replica set.
replicas integer | Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

### ReplicaSetList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ReplicaSet array | List of ReplicaSets. More info: http://kubernetes.io/docs/user-guide/replication-controller
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# ReplicationController v1

> ReplicationController Config to run 3 nginx instances.

    apiVersion: v1
    kind: ReplicationController
    metadata:
      # Unique key of the ReplicationController instance
      name: replicationcontroller-example
    spec:
      # 3 Pods should exist at all times.
      replicas: 3
      template:
        metadata:
          labels:
            app: nginx
        spec:
          containers:
          # Run the nginx image
          - name: nginx
            image: nginx:1.10

Group | Version | Kind
--- | --- | ---
Core | v1 | ReplicationController

In many cases it is recommended to create a Deployment instead of a ReplicationController.

ReplicationController represents the configuration of a replication controller.

Appears In ReplicationControllerList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec ReplicationControllerSpec | Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status ReplicationControllerStatus | Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### ReplicationControllerSpec v1

Appears In ReplicationController

Field | Description
--- | ---
minReadySeconds integer | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas integer | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller
selector object | Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template PodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

### ReplicationControllerStatus v1

Appears In ReplicationController

Field | Description
--- | ---
availableReplicas integer | The number of available replicas (ready for at least minReadySeconds) for this replication controller.
conditions ReplicationControllerCondition array | Represents the latest available observations of a replication controller's current state.
fullyLabeledReplicas integer | The number of pods that have labels matching the labels of the pod template of the replication controller.
observedGeneration integer | ObservedGeneration reflects the generation of the most recently observed replication controller.
readyReplicas integer | The number of ready replicas for this replication controller.
replicas integer | Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

### ReplicationControllerList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ReplicationController array | List of replication controllers. More info: http://kubernetes.io/docs/user-guide/replication-controller
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# StatefulSet v1beta1

Group | Version | Kind
--- | --- | ---
Apps | v1beta1 | StatefulSet

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.

Appears In StatefulSetList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta |
spec StatefulSetSpec | Spec defines the desired identities of pods in this set.
status StatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

### StatefulSetSpec v1beta1

Appears In StatefulSet

Field | Description
--- | ---
replicas integer | Replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
selector LabelSelector | Selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
serviceName string | ServiceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template PodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.

volumeClaimTemplates
PersistentVolumeClaim array

VolumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

### StatefulSetStatus v1beta1

Appears In StatefulSet

Field | Description
--- | ---
observedGeneration integer | most recent generation observed by this autoscaler.
replicas integer | Replicas is the number of actual replicas.

### StatefulSetList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items StatefulSet array |
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta |

# DISCOVERY & LOAD BALANCING

Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, Workloads are only accessible within the cluster, and they must be exposed externally using a either a LoadBalancer or NodePort Service. For development, internally accessible Workloads can be accessed via proxy through the api master using the `kubectl proxy` command.

Common resource types:

- Services for providing a single ip endpoint loadbalanced across multiple Workload replicas.
- Ingress for providing a https(s) endpoint http(s) routed to one or more Services

# Endpoints v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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}] }, ]

Appears In EndpointsList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

subsets
EndpointSubset array

The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

### EndpointsList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Endpoints array | List of endpoints.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# Ingress v1beta1

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | 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.

Appears In IngressList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec IngressSpec | Spec is the desired state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status IngressStatus | Status is the current state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### IngressSpec v1beta1

Appears In Ingress

Field | Description
--- | ---
backend IngressBackend | A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
rules IngressRule array | A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
tls IngressTLS array | TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

### IngressStatus v1beta1

Appears In Ingress

Field | Description
--- | ---
loadBalancer LoadBalancerStatus | LoadBalancer contains the current status of the load-balancer.

### IngressList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Ingress array | Items is the list of Ingress.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# Service v1

> Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.

    kind: Service
    apiVersion: v1
    metadata:
      # Unique key of the Service instance
      name: service-example
    spec:
      ports:
        # Accept traffic sent to port 80
        - name: http
          port: 80
          targetPort: 80
      selector:
        # Loadbalance traffic across Pods matching
        # this label selector
        app: nginx
      # Create an HA proxy in the cloud provider
      # with an External IP address - *Only supported
      # by some cloud providers*
      type: LoadBalancer

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In ServiceList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec ServiceSpec | Spec defines the behavior of a service. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status ServiceStatus | Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### ServiceSpec v1

Appears In Service

Field | Description
--- | ---

clusterIP
string

clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies

deprecatedPublicIPs string array | deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.

externalIPs
string array

externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.

externalName string | externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.
loadBalancerIP string | Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
loadBalancerSourceRanges string array | If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: http://kubernetes.io/docs/user-guide/services-firewalls
ports ServicePort array | The list of ports that are exposed by this service. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
selector object | Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#overview
sessionAffinity string | Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies

type
string

type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://kubernetes.io/docs/user-guide/services#overview

### ServiceStatus v1

Appears In Service

Field | Description
--- | ---
loadBalancer LoadBalancerStatus | LoadBalancer contains the current status of the load-balancer, if one is present.

### ServiceList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Service array | List of services
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# CONFIG & STORAGE

Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.

Common resource types:

- ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
- Secrets for providing binary data injected into the application through files
- Volumes for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.

# ConfigMap v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ConfigMap

ConfigMap holds configuration data for pods to consume.

Appears In ConfigMapList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
data object | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

### ConfigMapList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ConfigMap array | Items is the list of ConfigMaps.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# Secret v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In SecretList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
data object | Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
stringData object | stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
type string | Used to facilitate programmatic handling of secret data.

### SecretList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Secret array | Items is a list of secret objects. More info: http://kubernetes.io/docs/user-guide/secrets
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# PersistentVolumeClaim v1

Group | Version | Kind
--- | --- | ---
Core | v1 | PersistentVolumeClaim

A PersistentVolume must be allocated in the cluster to use this.

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Appears In PersistentVolumeClaimList StatefulSetSpec

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec PersistentVolumeClaimSpec | Spec defines the desired characteristics of a volume requested by a pod author. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims
status PersistentVolumeClaimStatus | Status represents the current information/status of a persistent volume claim. Read-only. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

### PersistentVolumeClaimSpec v1

Appears In PersistentVolumeClaim

Field | Description
--- | ---
accessModes string array | AccessModes contains the desired access modes the volume should have. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes-1
resources ResourceRequirements | Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#resources
selector LabelSelector | A label query over volumes to consider for binding.
volumeName string | VolumeName is the binding reference to the PersistentVolume backing this claim.

### PersistentVolumeClaimStatus v1

Appears In PersistentVolumeClaim

Field | Description
--- | ---
accessModes string array | AccessModes contains the actual access modes the volume backing the PVC has. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes-1
capacity object | Represents the actual resources of the underlying volume.
phase string | Phase represents the current phase of PersistentVolumeClaim.

### PersistentVolumeClaimList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items PersistentVolumeClaim array | A list of persistent volume claims. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# StorageClass v1beta1

Group | Version | Kind
--- | --- | ---
Storage | v1beta1 | StorageClass

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

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Appears In StorageClassList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
parameters object | Parameters holds the parameters for the provisioner that should create volumes of this storage class.
provisioner string | Provisioner indicates the type of the provisioner.

### StorageClassList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items StorageClass array | Items is the list of StorageClasses
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# Volume v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Appears In PodSpec

Field | Description
--- | ---
awsElasticBlockStore AWSElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
azureDisk AzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile AzureFileVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
cephfs CephFSVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder CinderVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
configMap ConfigMapVolumeSource | ConfigMap represents a configMap that should populate this volume
downwardAPI DownwardAPIVolumeSource | DownwardAPI represents downward API about the pod that should populate this volume
emptyDir EmptyDirVolumeSource | EmptyDir represents a temporary directory that shares a pod's lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
fc FCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume FlexVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
flocker FlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
gcePersistentDisk GCEPersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
gitRepo GitRepoVolumeSource | GitRepo represents a git repository at a particular revision.
glusterfs GlusterfsVolumeSource | Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath HostPathVolumeSource | HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
iscsi ISCSIVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md
name string | Volume's name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names
nfs NFSVolumeSource | NFS represents an NFS mount on the host that shares a pod's lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs
persistentVolumeClaim PersistentVolumeClaimVolumeSource | PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims
photonPersistentDisk PhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
quobyte QuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd RBDVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
secret SecretVolumeSource | Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets
vsphereVolume VsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

# METADATA

Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.

Common resource types:

- HorizontalPodAutoscaler (HPA) for automatically scaling the replicacount of your workloads in response to load
- PodDisruptionBudget for configuring how many replicas in a given workload maybe made concurrently unavailable when performing maintenance.
- ThirdPartyResource for extending the Kubernetes APIs with your own types
- Event for notification of resource lifecycle events in the cluster.

# Event v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Event

Other api versions of this object exist: versioned

Event is a report of an event somewhere in the cluster.

Appears In EventList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
count integer | The number of times this event has occurred.
firstTimestamp Time | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
involvedObject ObjectReference | The object that this event is about.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
lastTimestamp Time | The time at which the most recent occurrence of this event was recorded.
message string | A human-readable description of the status of this operation.
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
reason string | This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
source EventSource | The component reporting this event. Should be a short machine understandable string.
type string | Type of this event (Normal, Warning), new types could be added in the future

### EventList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Event array | List of events
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# LimitRange v1

Group | Version | Kind
--- | --- | ---
Core | v1 | LimitRange

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

Appears In LimitRangeList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec LimitRangeSpec | Spec defines the limits enforced. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### LimitRangeSpec v1

Appears In LimitRange

Field | Description
--- | ---
limits LimitRangeItem array | Limits is the list of LimitRangeItem objects that are enforced.

### LimitRangeList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items LimitRange array | Items is a list of LimitRange objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# HorizontalPodAutoscaler v1

Group | Version | Kind
--- | --- | ---
Autoscaling | v1 | HorizontalPodAutoscaler

Other api versions of this object exist: v1beta1

configuration of a horizontal pod autoscaler.

Appears In HorizontalPodAutoscalerList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec HorizontalPodAutoscalerSpec | behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
status HorizontalPodAutoscalerStatus | current information about the autoscaler.

### HorizontalPodAutoscalerSpec v1

Appears In HorizontalPodAutoscaler

Field | Description
--- | ---
maxReplicas integer | upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
minReplicas integer | lower limit for the number of pods that can be set by the autoscaler, default 1.
scaleTargetRef CrossVersionObjectReference | reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
targetCPUUtilizationPercentage integer | target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.

### HorizontalPodAutoscalerStatus v1

Appears In HorizontalPodAutoscaler

Field | Description
--- | ---
currentCPUUtilizationPercentage integer | current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
currentReplicas integer | current number of replicas of pods managed by this autoscaler.
desiredReplicas integer | desired number of replicas of pods managed by this autoscaler.
lastScaleTime Time | last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
observedGeneration integer | most recent generation observed by this autoscaler.

### HorizontalPodAutoscalerList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items HorizontalPodAutoscaler array | list of horizontal pod autoscaler objects.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata.

# PodTemplate v1

Group | Version | Kind
--- | --- | ---
Core | v1 | PodTemplate

PodTemplate describes a template for creating copies of a predefined pod.

Appears In PodTemplateList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
template PodTemplateSpec | Template defines the pods that will be created from this pod template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### PodTemplateSpec v1

Appears In DaemonSetSpec DeploymentSpec JobSpec PodTemplate ReplicaSetSpec ReplicationControllerSpec StatefulSetSpec

Field | Description
--- | ---
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec PodSpec | Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### PodTemplateList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items PodTemplate array | List of pod templates
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# PodDisruptionBudget v1beta1

Group | Version | Kind
--- | --- | ---
Policy | v1beta1 | PodDisruptionBudget

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

Appears In PodDisruptionBudgetList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta |
spec PodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget.
status PodDisruptionBudgetStatus | Most recently observed status of the PodDisruptionBudget.

### PodDisruptionBudgetSpec v1beta1

Appears In PodDisruptionBudget

Field | Description
--- | ---
minAvailable IntOrString | An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector LabelSelector | Label query over pods whose evictions are managed by the disruption budget.

### PodDisruptionBudgetStatus v1beta1

Appears In PodDisruptionBudget

Field | Description
--- | ---
currentHealthy integer | current number of healthy pods
desiredHealthy integer | minimum desired number of healthy pods

disruptedPods
object

DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.

disruptionsAllowed integer | Number of pod disruptions that are currently allowed.
expectedPods integer | total number of pods counted by this disruption budget
observedGeneration integer | Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation.

### PodDisruptionBudgetList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items PodDisruptionBudget array |
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta |

# ThirdPartyResource v1beta1

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | ThirdPartyResource

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.

Appears In ThirdPartyResourceList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
description string | Description is the description of this object.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object metadata
versions APIVersion array | Versions are versions for this third party object

### ThirdPartyResourceList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ThirdPartyResource array | Items is the list of ThirdPartyResources.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata.

# CLUSTER

Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.

# Binding v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Binding

Binding ties one object to another. For example, a pod is bound to a node by a scheduler.

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
target ObjectReference | The target object that you want to bind to the standard object.

# CertificateSigningRequest v1alpha1

Group | Version | Kind
--- | --- | ---
Certificates | v1alpha1 | CertificateSigningRequest

Describes a certificate signing request

Appears In CertificateSigningRequestList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta |
spec CertificateSigningRequestSpec | The certificate request itself and any additional information.
status CertificateSigningRequestStatus | Derived information about the request.

### CertificateSigningRequestSpec v1alpha1

Appears In CertificateSigningRequest

Field | Description
--- | ---
groups string array |
request string | Base64-encoded PKCS#10 CSR data
uid string |
username string | Information about the requesting user (if relevant) See user.Info interface for details

### CertificateSigningRequestStatus v1alpha1

Appears In CertificateSigningRequest

Field | Description
--- | ---
certificate string | If request was approved, the controller will place the issued certificate here.
conditions CertificateSigningRequestCondition array | Conditions applied to the request, such as approval or denial.

### CertificateSigningRequestList v1alpha1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items CertificateSigningRequest array |
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta |

# ClusterRole v1alpha1

Group | Version | Kind
--- | --- | ---
RbacAuthorization | v1alpha1 | ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Appears In ClusterRoleList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata.
rules PolicyRule array | Rules holds all the PolicyRules for this ClusterRole

### ClusterRoleList v1alpha1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ClusterRole array | Items is a list of ClusterRoles
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard object's metadata.

# ClusterRoleBinding v1alpha1

Group | Version | Kind
--- | --- | ---
RbacAuthorization | v1alpha1 | ClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

Appears In ClusterRoleBindingList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata.
roleRef RoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects Subject array | Subjects holds references to the objects the role applies to.

### ClusterRoleBindingList v1alpha1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ClusterRoleBinding array | Items is a list of ClusterRoleBindings
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard object's metadata.

# ComponentStatus v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ComponentStatus

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

Appears In ComponentStatusList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
conditions ComponentCondition array | List of component conditions observed
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

### ComponentStatusList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ComponentStatus array | List of ComponentStatus objects.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# LocalSubjectAccessReview v1beta1

Group | Version | Kind
--- | --- | ---
Authorization | v1beta1 | 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.

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta |
spec SubjectAccessReviewSpec | Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
status SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

# Namespace v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Namespace

Namespace provides a scope for Names. Use of multiple namespaces is optional.

Appears In NamespaceList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec NamespaceSpec | Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status NamespaceStatus | Status describes the current status of a Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### NamespaceSpec v1

Appears In Namespace

Field | Description
--- | ---
finalizers string array | Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers

### NamespaceStatus v1

Appears In Namespace

Field | Description
--- | ---
phase string | Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases

### NamespaceList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Namespace array | Items is the list of Namespace objects in the list. More info: http://kubernetes.io/docs/user-guide/namespaces
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# Node v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Node

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Appears In NodeList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec NodeSpec | Spec defines the behavior of a node. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status NodeStatus | Most recently observed status of the node. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### NodeSpec v1

Appears In Node

Field | Description
--- | ---
externalID string | External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.
podCIDR string | PodCIDR represents the pod IP range assigned to the node.
providerID string | ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
unschedulable boolean | Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration"

### NodeStatus v1

Appears In Node

Field | Description
--- | ---
addresses NodeAddress array | List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses
allocatable object | Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity object | Capacity represents the total resources of a node. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#capacity for more details.
conditions NodeCondition array | Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition
daemonEndpoints NodeDaemonEndpoints | Endpoints of daemons running on the Node.
images ContainerImage array | List of container images on this node
nodeInfo NodeSystemInfo | Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info
phase string | NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase The field is never populated, and now is deprecated.
volumesAttached AttachedVolume array | List of volumes that are attached to the node.
volumesInUse string array | List of attachable volumes in use (mounted) by the node.

### NodeList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Node array | List of nodes
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# PersistentVolume v1

Group | Version | Kind
--- | --- | ---
Core | v1 | PersistentVolume

These are assigned to Pods using PersistentVolumeClaims.

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/

Appears In PersistentVolumeList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec PersistentVolumeSpec | Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistent-volumes
status PersistentVolumeStatus | Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistent-volumes

### PersistentVolumeSpec v1

Appears In PersistentVolume

Field | Description
--- | ---
accessModes string array | AccessModes contains all ways the volume can be mounted. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes
awsElasticBlockStore AWSElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
azureDisk AzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile AzureFileVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
capacity object | A description of the persistent volume's resources and capacity. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#capacity
cephfs CephFSVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder CinderVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
claimRef ObjectReference | ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding
fc FCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume FlexVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
flocker FlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
gcePersistentDisk GCEPersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
glusterfs GlusterfsVolumeSource | Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath HostPathVolumeSource | HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
iscsi ISCSIVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
nfs NFSVolumeSource | NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#nfs
persistentVolumeReclaimPolicy string | What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#recycling-policy
photonPersistentDisk PhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
quobyte QuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd RBDVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
vsphereVolume VsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

### PersistentVolumeStatus v1

Appears In PersistentVolume

Field | Description
--- | ---
message string | A human-readable message indicating details about why the volume is in this state.
phase string | Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#phase
reason string | Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

### PersistentVolumeList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items PersistentVolume array | List of persistent volumes. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# ResourceQuota v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace

Appears In ResourceQuotaList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec ResourceQuotaSpec | Spec defines the desired quota. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status ResourceQuotaStatus | Status defines the actual enforced quota and its current usage. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### ResourceQuotaSpec v1

Appears In ResourceQuota

Field | Description
--- | ---
hard object | Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota
scopes string array | A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

### ResourceQuotaStatus v1

Appears In ResourceQuota

Field | Description
--- | ---
hard object | Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota
used object | Used is the current observed total usage of the resource in the namespace.

### ResourceQuotaList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ResourceQuota array | Items is a list of ResourceQuota objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# Role v1alpha1

Group | Version | Kind
--- | --- | ---
RbacAuthorization | v1alpha1 | Role

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

Appears In RoleList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata.
rules PolicyRule array | Rules holds all the PolicyRules for this Role

### RoleList v1alpha1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Role array | Items is a list of Roles
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard object's metadata.

# RoleBinding v1alpha1

Group | Version | Kind
--- | --- | ---
RbacAuthorization | v1alpha1 | 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.

Appears In RoleBindingList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata.
roleRef RoleRef | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects Subject array | Subjects holds references to the objects the role applies to.

### RoleBindingList v1alpha1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items RoleBinding array | Items is a list of RoleBindings
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard object's metadata.

# SelfSubjectAccessReview v1beta1

Group | Version | Kind
--- | --- | ---
Authorization | v1beta1 | 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

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta |
spec SelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. user and groups must be empty
status SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

### SelfSubjectAccessReviewSpec v1beta1

Appears In SelfSubjectAccessReview

Field | Description
--- | ---
nonResourceAttributes NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request
resourceAttributes ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request

# ServiceAccount v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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

Appears In ServiceAccountList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

imagePullSecrets
LocalObjectReference array

ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://kubernetes.io/docs/user-guide/secrets#manually-specifying-an-imagepullsecret

kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
secrets ObjectReference array | Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: http://kubernetes.io/docs/user-guide/secrets

### ServiceAccountList v1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ServiceAccount array | List of ServiceAccounts. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

# SubjectAccessReview v1beta1

Group | Version | Kind
--- | --- | ---
Authorization | v1beta1 | SubjectAccessReview

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

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta |
spec SubjectAccessReviewSpec | Spec holds information about the request being evaluated
status SubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not

### SubjectAccessReviewSpec v1beta1

Appears In LocalSubjectAccessReview SubjectAccessReview

Field | Description
--- | ---
extra object | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
group string array | Groups is the groups you're testing for.
nonResourceAttributes NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request
resourceAttributes ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request
user string | User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups

### SubjectAccessReviewStatus v1beta1

Appears In LocalSubjectAccessReview SelfSubjectAccessReview SubjectAccessReview

Field | Description
--- | ---
allowed boolean | Allowed is required. True if the action would be allowed, false otherwise.
evaluationError string | EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
reason string | Reason is optional. It indicates why a request was allowed or denied.

# TokenReview v1beta1

Group | Version | Kind
--- | --- | ---
Authentication | v1beta1 | 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.

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta |
spec TokenReviewSpec | Spec holds information about the request being evaluated
status TokenReviewStatus | Status is filled in by the server and indicates whether the request can be authenticated.

### TokenReviewSpec v1beta1

Appears In TokenReview

Field | Description
--- | ---
token string | Token is the opaque bearer token.

### TokenReviewStatus v1beta1

Appears In TokenReview

Field | Description
--- | ---
authenticated boolean | Authenticated indicates that the token was associated with a known user.
error string | Error indicates that the token couldn't be checked
user UserInfo | User is the UserInfo associated with the provided token.

# NetworkPolicy v1beta1

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | NetworkPolicy

Appears In NetworkPolicyList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec NetworkPolicySpec | Specification of the desired behavior for this NetworkPolicy.

### NetworkPolicySpec v1beta1

Appears In NetworkPolicy

Field | Description
--- | ---

ingress
NetworkPolicyIngressRule array

List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list.

podSelector
LabelSelector

Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.

### NetworkPolicyList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items NetworkPolicy array | Items is a list of schema objects.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# DEFINITIONS

This section contains definitions for objects used in the Kubernetes APIs.

## APIGroup unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | APIGroup

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

Appears In APIGroupList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
name string | name is the name of the group.
preferredVersion GroupVersionForDiscovery | preferredVersion is the version preferred by the API server, which probably is the storage version.

serverAddressByClientCIDRs
ServerAddressByClientCIDR array

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

versions GroupVersionForDiscovery array | versions are the versions supported in this group.

## APIResource unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | APIResource

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

Appears In APIResourceList

Field | Description
--- | ---
kind string | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
name string | name is the name of the resource.
namespaced boolean | namespaced indicates if a resource is namespaced or not.

## APIVersion v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | APIVersion

An APIVersion represents a single concrete version of an object model.

Appears In ThirdPartyResource

Field | Description
--- | ---
name string | Name of this version (e.g. 'v1').

## APIVersions unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | 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.

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

serverAddressByClientCIDRs
ServerAddressByClientCIDR array

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

versions string array | versions are the api versions that are available.

## AWSElasticBlockStoreVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | AWSElasticBlockStoreVolumeSource

Represents a Persistent Disk resource in AWS.

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
partition integer | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
readOnly boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
volumeID string | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

## AttachedVolume v1

Group | Version | Kind
--- | --- | ---
Core | v1 | AttachedVolume

AttachedVolume describes a volume attached to a node

Appears In NodeStatus

Field | Description
--- | ---
devicePath string | DevicePath represents the device path where the volume should be available
name string | Name of the attached volume

## AzureDiskVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
cachingMode string | Host Caching mode: None, Read Only, Read Write.
diskName string | The Name of the data disk in the blob storage
diskURI string | The URI the data disk in the blob storage
fsType string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnly boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

## AzureFileVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
readOnly boolean | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName string | the name of secret that contains Azure Storage Account Name and Key
shareName string | Share Name

## CPUTargetUtilization v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | CPUTargetUtilization

Appears In HorizontalPodAutoscalerSpec

Field | Description
--- | ---
targetPercentage integer | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use.

## Capabilities v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Capabilities

Adds and removes POSIX capabilities from running containers.

Appears In SecurityContext

Field | Description
--- | ---
add string array | Added capabilities
drop string array | Removed capabilities

## CephFSVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
monitors string array | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
path string | Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly boolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretFile string | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretRef LocalObjectReference | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
user string | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

## CertificateSigningRequestCondition v1alpha1

Group | Version | Kind
--- | --- | ---
Core | v1alpha1 | CertificateSigningRequestCondition

Appears In CertificateSigningRequestStatus

Field | Description
--- | ---
lastUpdateTime Time | timestamp for the last update to this condition
message string | human readable message with details about the request state
reason string | brief reason for the request state
type string | request approval state, currently Approved or Denied.

## CinderVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
readOnly boolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
volumeID string | volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

## ComponentCondition v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ComponentCondition

Information about the condition of a component.

Appears In ComponentStatus

Field | Description
--- | ---
error string | Condition error code for a component. For example, a health check error code.
message string | Message about the condition for a component. For example, information about a health check.
status string | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
type string | Type of condition for a component. Valid value: "Healthy"

## ConfigMapKeySelector v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ConfigMapKeySelector

Selects a key from a ConfigMap.

Appears In EnvVarSource

Field | Description
--- | ---
key string | The key to select.
name string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

## ConfigMapVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ConfigMapVolumeSource

Adapts a ConfigMap into a volume.

The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

Appears In Volume

Field | Description
--- | ---
defaultMode integer | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

items
KeyToPath array

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.

name string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

## ContainerImage v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ContainerImage

Describe a container image

Appears In NodeStatus

Field | Description
--- | ---
names string array | Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
sizeBytes integer | The size of the image in bytes.

## ContainerPort v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ContainerPort

ContainerPort represents a network port in a single container.

Appears In Container

Field | Description
--- | ---
containerPort integer | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
hostIP string | What host IP to bind the external port to.
hostPort integer | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
name string | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol string | Protocol for port. Must be UDP or TCP. Defaults to "TCP".

## ContainerState v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In ContainerStatus

Field | Description
--- | ---
running ContainerStateRunning | Details about a running container
terminated ContainerStateTerminated | Details about a terminated container
waiting ContainerStateWaiting | Details about a waiting container

## ContainerStateRunning v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ContainerStateRunning

ContainerStateRunning is a running state of a container.

Appears In ContainerState

Field | Description
--- | ---
startedAt Time | Time at which the container was last (re-)started

## ContainerStateTerminated v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.

Appears In ContainerState

Field | Description
--- | ---
containerID string | Container's ID in the format 'docker://<container_id>'
exitCode integer | Exit status from the last termination of the container
finishedAt Time | Time at which the container last terminated
message string | Message regarding the last termination of the container
reason string | (brief) reason from the last termination of the container
signal integer | Signal from the last termination of the container
startedAt Time | Time at which previous execution of the container started

## ContainerStateWaiting v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ContainerStateWaiting

ContainerStateWaiting is a waiting state of a container.

Appears In ContainerState

Field | Description
--- | ---
message string | Message regarding why the container is not yet running.
reason string | (brief) reason the container is not yet running.

## CrossVersionObjectReference v1

Group | Version | Kind
--- | --- | ---
Core | v1 | CrossVersionObjectReference

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Appears In HorizontalPodAutoscalerSpec

Field | Description
--- | ---
apiVersion string | API version of the referent
kind string | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
name string | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

## DaemonEndpoint v1

Group | Version | Kind
--- | --- | ---
Core | v1 | DaemonEndpoint

DaemonEndpoint contains information about a single Daemon endpoint.

Appears In NodeDaemonEndpoints

Field | Description
--- | ---
Port integer | Port number of the given endpoint.

## DeleteOptions v1

Group | Version | Kind
--- | --- | ---
Core | v1 | DeleteOptions

DeleteOptions may be provided when deleting an API object

Appears In Eviction

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
gracePeriodSeconds integer | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
orphanDependents boolean | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
preconditions Preconditions | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

## DeploymentCondition v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | DeploymentCondition

DeploymentCondition describes the state of a deployment at a certain point.

Appears In DeploymentStatus

Field | Description
--- | ---
lastTransitionTime Time | Last time the condition transitioned from one status to another.
lastUpdateTime Time | The last time this condition was updated.
message string | A human readable message indicating details about the transition.
reason string | The reason for the condition's last transition.
status string | Status of the condition, one of True, False, Unknown.
type string | Type of deployment condition.

## DownwardAPIVolumeFile v1

Group | Version | Kind
--- | --- | ---
Core | v1 | DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Appears In DownwardAPIVolumeSource

Field | Description
--- | ---
fieldRef ObjectFieldSelector | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode integer | Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path string | Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef ResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

## DownwardAPIVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Appears In Volume

Field | Description
--- | ---
defaultMode integer | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items DownwardAPIVolumeFile array | Items is a list of downward API volume file

## EmptyDirVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Appears In Volume

Field | Description
--- | ---
medium string | What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

## EndpointAddress v1

Group | Version | Kind
--- | --- | ---
Core | v1 | EndpointAddress

EndpointAddress is a tuple that describes single IP address.

Appears In EndpointSubset

Field | Description
--- | ---
hostname string | The Hostname of this endpoint
ip string | The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
nodeName string | Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
targetRef ObjectReference | Reference to object providing the endpoint.

## EndpointPort v1

Group | Version | Kind
--- | --- | ---
Core | v1 | EndpointPort

EndpointPort is a tuple that describes a single port.

Appears In EndpointSubset

Field | Description
--- | ---
name string | The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.
port integer | The port number of the endpoint.
protocol string | The IP protocol for this port. Must be UDP or TCP. Default is TCP.

## EndpointSubset v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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 ]

Appears In Endpoints

Field | Description
--- | ---
addresses EndpointAddress array | IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
notReadyAddresses EndpointAddress array | IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
ports EndpointPort array | Port numbers available on the related IP addresses.

## EnvVar v1

Group | Version | Kind
--- | --- | ---
Core | v1 | EnvVar

EnvVar represents an environment variable present in a Container.

Appears In Container

Field | Description
--- | ---
name string | Name of the environment variable. Must be a C_IDENTIFIER.

value
string

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

valueFrom EnvVarSource | Source for the environment variable's value. Cannot be used if value is not empty.

## EnvVarSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Appears In EnvVar

Field | Description
--- | ---
configMapKeyRef ConfigMapKeySelector | Selects a key of a ConfigMap.
fieldRef ObjectFieldSelector | Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.
resourceFieldRef ResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
secretKeyRef SecretKeySelector | Selects a key of a secret in the pod's namespace

## EventSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | EventSource

EventSource contains information for an event.

Appears In Event

Field | Description
--- | ---
component string | Component from which the event is generated.
host string | Node name on which the event is generated.

## Eviction v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | 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/<pod name>/evictions.

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
deleteOptions DeleteOptions | DeleteOptions may be provided
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | ObjectMeta describes the pod that is being evicted.

## ExecAction v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ExecAction

ExecAction describes a "run in container" action.

Appears In Handler Probe

Field | Description
--- | ---

command
string array

Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('

', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

## FCVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
lun integer | Required: FC target lun number
readOnly boolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs string array | Required: FC target worldwide names (WWNs)

## FlexVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | FlexVolumeSource

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
driver string | Driver is the name of the driver to use for this volume.
fsType string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
options object | Optional: Extra command options if any.
readOnly boolean | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef LocalObjectReference | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

## FlockerVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
datasetName string | Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUID string | UUID of the dataset. This is unique identifier of a Flocker dataset

## GCEPersistentDiskVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | GCEPersistentDiskVolumeSource

Represents a Persistent Disk resource in Google Compute Engine.

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
partition integer | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
pdName string | Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
readOnly boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

## GitRepoVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In Volume

Field | Description
--- | ---
directory string | Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repository string | Repository URL
revision string | Commit hash for the specified revision.

## GlusterfsVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
endpoints string | EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
path string | Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
readOnly boolean | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

## GroupVersionForDiscovery unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | GroupVersionForDiscovery

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

Appears In APIGroup

Field | Description
--- | ---
groupVersion string | groupVersion specifies the API group and version in the form "group/version"
version string | version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.

## HTTPGetAction v1

Group | Version | Kind
--- | --- | ---
Core | v1 | HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Appears In Handler Probe

Field | Description
--- | ---
host string | Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
httpHeaders HTTPHeader array | Custom headers to set in the request. HTTP allows repeated headers.
path string | Path to access on the HTTP server.
port IntOrString | Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme string | Scheme to use for connecting to the host. Defaults to HTTP.

## HTTPHeader v1

Group | Version | Kind
--- | --- | ---
Core | v1 | HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Appears In HTTPGetAction

Field | Description
--- | ---
name string | The header field name
value string | The header field value

## HTTPIngressPath v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | HTTPIngressPath

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

Appears In HTTPIngressRuleValue

Field | Description
--- | ---
backend IngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to.

path
string

Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend.

## HTTPIngressRuleValue v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | HTTPIngressRuleValue

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> 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 '#'.

Appears In IngressRule

Field | Description
--- | ---
paths HTTPIngressPath array | A collection of paths that map requests to backends.

## Handler v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Handler

Handler defines a specific action that should be taken

Appears In Lifecycle

Field | Description
--- | ---
exec ExecAction | One and only one of the following should be specified. Exec specifies the action to take.
httpGet HTTPGetAction | HTTPGet specifies the http request to perform.
tcpSocket TCPSocketAction | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

## HostPathVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
path string | Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

## ISCSIVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi
iqn string | Target iSCSI Qualified Name.
iscsiInterface string | Optional: Defaults to 'default' (tcp). iSCSI interface name that uses an iSCSI transport.
lun integer | iSCSI target lun number.
readOnly boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
targetPortal string | iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

## Info version

Group | Version | Kind
--- | --- | ---
Core | version | Info

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

Field | Description
--- | ---
buildDate string |
compiler string |
gitCommit string |
gitTreeState string |
gitVersion string |
goVersion string |
major string |
minor string |
platform string |

## IngressBackend v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | IngressBackend

IngressBackend describes all endpoints for a given service and port.

Appears In HTTPIngressPath IngressSpec

Field | Description
--- | ---
serviceName string | Specifies the name of the referenced service.
servicePort IntOrString | Specifies the port of the referenced service.

## IngressRule v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | 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.

Appears In IngressSpec

Field | Description
--- | ---

host
string

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.

http HTTPIngressRuleValue |

## IngressTLS v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | IngressTLS

IngressTLS describes the transport layer security associated with an Ingress.

Appears In IngressSpec

Field | Description
--- | ---
hosts string array | Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
secretName string | SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

## IntOrString intstr

Group | Version | Kind
--- | --- | ---
Core | intstr | IntOrString

Appears In HTTPGetAction IngressBackend NetworkPolicyPort PodDisruptionBudgetSpec RollingUpdateDeployment ServicePort TCPSocketAction

Field | Description
--- | ---

## JobCondition v1

Group | Version | Kind
--- | --- | ---
Core | v1 | JobCondition

Other api versions of this object exist: v1beta1 v2alpha1

JobCondition describes current state of a job.

Appears In JobStatus

Field | Description
--- | ---
lastProbeTime Time | Last time the condition was checked.
lastTransitionTime Time | Last time the condition transit from one status to another.
message string | Human readable message indicating details about last transition.
reason string | (brief) reason for the condition's last transition.
status string | Status of the condition, one of True, False, Unknown.
type string | Type of job condition, Complete or Failed.

## JobTemplateSpec v2alpha1

Group | Version | Kind
--- | --- | ---
Core | v2alpha1 | JobTemplateSpec

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

Appears In CronJobSpec

Field | Description
--- | ---
metadata ObjectMeta | Standard object's metadata of the jobs created from this template. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec JobSpec | Specification of the desired behavior of the job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

## KeyToPath v1

Group | Version | Kind
--- | --- | ---
Core | v1 | KeyToPath

Maps a string key to a path within a volume.

Appears In ConfigMapVolumeSource SecretVolumeSource

Field | Description
--- | ---
key string | The key to project.
mode integer | Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path string | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

## LabelSelector unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | 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.

Appears In DaemonSetSpec DeploymentSpec JobSpec NetworkPolicyPeer NetworkPolicySpec PersistentVolumeClaimSpec PodDisruptionBudgetSpec ReplicaSetSpec StatefulSetSpec

Field | Description
--- | ---
matchExpressions LabelSelectorRequirement array | matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels object | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

## LabelSelectorRequirement unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | LabelSelectorRequirement

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

Appears In LabelSelector

Field | Description
--- | ---
key string | key is the label key that the selector applies to.
operator string | operator represents a key's relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
values string array | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

## Lifecycle v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In Container

Field | Description
--- | ---
postStart Handler | PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details

preStop
Handler

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details

## LimitRangeItem v1

Group | Version | Kind
--- | --- | ---
Core | v1 | LimitRangeItem

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

Appears In LimitRangeSpec

Field | Description
--- | ---
default object | Default resource requirement limit value by resource name if resource limit is omitted.
defaultRequest object | DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
max object | Max usage constraints on this kind by resource name.
maxLimitRequestRatio object | MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
min object | Min usage constraints on this kind by resource name.
type string | Type of resource that this limit applies to.

## ListMeta unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | ListMeta

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

Appears In CertificateSigningRequestList ClusterRoleBindingList ClusterRoleList ComponentStatusList ConfigMapList CronJobList DaemonSetList DeploymentList EndpointsList EventList HorizontalPodAutoscalerList IngressList JobList LimitRangeList NamespaceList NetworkPolicyList NodeList PersistentVolumeClaimList PersistentVolumeList PodDisruptionBudgetList PodList PodTemplateList ReplicaSetList ReplicationControllerList ResourceQuotaList RoleBindingList RoleList SecretList ServiceAccountList ServiceList StatefulSetList Status StorageClassList ThirdPartyResourceList

Field | Description
--- | ---
resourceVersion string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
selfLink string | SelfLink is a URL representing this object. Populated by the system. Read-only.

## LoadBalancerIngress v1

Group | Version | Kind
--- | --- | ---
Core | v1 | LoadBalancerIngress

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

Appears In LoadBalancerStatus

Field | Description
--- | ---
hostname string | Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip string | IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

## LoadBalancerStatus v1

Group | Version | Kind
--- | --- | ---
Core | v1 | LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.

Appears In IngressStatus ServiceStatus

Field | Description
--- | ---
ingress LoadBalancerIngress array | Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

## LocalObjectReference v1

Group | Version | Kind
--- | --- | ---
Core | v1 | LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Appears In CephFSVolumeSource FlexVolumeSource PodSpec RBDVolumeSource ServiceAccount

Field | Description
--- | ---
name string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

## NFSVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
path string | Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs
readOnly boolean | ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs
server string | Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

## NetworkPolicyIngressRule v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | NetworkPolicyIngressRule

This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

Appears In NetworkPolicySpec

Field | Description
--- | ---

from
NetworkPolicyPeer array

List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.

ports
NetworkPolicyPort array

List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.

## NetworkPolicyPeer v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | NetworkPolicyPeer

Appears In NetworkPolicyIngressRule

Field | Description
--- | ---
namespaceSelector LabelSelector | Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.
podSelector LabelSelector | This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.

## NetworkPolicyPort v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | NetworkPolicyPort

Appears In NetworkPolicyIngressRule

Field | Description
--- | ---
port IntOrString | If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
protocol string | Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

## NodeAddress v1

Group | Version | Kind
--- | --- | ---
Core | v1 | NodeAddress

NodeAddress contains information for the node's address.

Appears In NodeStatus

Field | Description
--- | ---
address string | The node address.
type string | Node address type, one of Hostname, ExternalIP or InternalIP.

## NodeCondition v1

Group | Version | Kind
--- | --- | ---
Core | v1 | NodeCondition

NodeCondition contains condition information for a node.

Appears In NodeStatus

Field | Description
--- | ---
lastHeartbeatTime Time | Last time we got an update on a given condition.
lastTransitionTime Time | Last time the condition transit from one status to another.
message string | Human readable message indicating details about last transition.
reason string | (brief) reason for the condition's last transition.
status string | Status of the condition, one of True, False, Unknown.
type string | Type of node condition.

## NodeDaemonEndpoints v1

Group | Version | Kind
--- | --- | ---
Core | v1 | NodeDaemonEndpoints

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Appears In NodeStatus

Field | Description
--- | ---
kubeletEndpoint DaemonEndpoint | Endpoint on which Kubelet is listening.

## NodeSystemInfo v1

Group | Version | Kind
--- | --- | ---
Core | v1 | NodeSystemInfo

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Appears In NodeStatus

Field | Description
--- | ---
architecture string | The Architecture reported by the node
bootID string | Boot ID reported by the node.
containerRuntimeVersion string | ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
kernelVersion string | Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
kubeProxyVersion string | KubeProxy Version reported by the node.
kubeletVersion string | Kubelet Version reported by the node.
machineID string | MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
operatingSystem string | The Operating System reported by the node
osImage string | OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
systemUUID string | SystemUUID reported by the node. For unique machine identification MachineID is prefered. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html

## NonResourceAttributes v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | NonResourceAttributes

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

Appears In SelfSubjectAccessReviewSpec SubjectAccessReviewSpec

Field | Description
--- | ---
path string | Path is the URL path of the request
verb string | Verb is the standard HTTP verb

## ObjectFieldSelector v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Appears In DownwardAPIVolumeFile EnvVarSource

Field | Description
--- | ---
apiVersion string | Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath string | Path of the field to select in the specified API version.

## ObjectMeta v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ObjectMeta

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

Appears In Binding CertificateSigningRequest ClusterRole ClusterRoleBinding ComponentStatus ConfigMap CronJob DaemonSet Deployment Endpoints Event Eviction HorizontalPodAutoscaler Ingress Job JobTemplateSpec LimitRange LocalSubjectAccessReview Namespace NetworkPolicy Node PersistentVolume PersistentVolumeClaim Pod PodDisruptionBudget PodTemplate PodTemplateSpec ReplicaSet ReplicationController ResourceQuota Role RoleBinding Scale Secret SelfSubjectAccessReview Service ServiceAccount StatefulSet StorageClass SubjectAccessReview ThirdPartyResource TokenReview

Field | Description
--- | ---
annotations object | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
clusterName string | The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

creationTimestamp
Time

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

deletionGracePeriodSeconds integer | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp
Time

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

finalizers string array | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

generateName
string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

generation integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels object | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
name string | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace
string

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences OwnerReference array | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion
string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

selfLink string | SelfLink is a URL representing this object. Populated by the system. Read-only.
uid string | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## ObjectReference v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

Appears In Binding CronJobStatus EndpointAddress Event PersistentVolumeSpec ServiceAccount

Field | Description
--- | ---
apiVersion string | API version of the referent.

fieldPath
string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kind string | Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
name string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
namespace string | Namespace of the referent. More info: http://kubernetes.io/docs/user-guide/namespaces
resourceVersion string | Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
uid string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## OwnerReference v1

Group | Version | Kind
--- | --- | ---
Core | v1 | OwnerReference

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.

Appears In ObjectMeta

Field | Description
--- | ---
apiVersion string | API version of the referent.
controller boolean | If true, this reference points to the managing controller.
kind string | Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
name string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
uid string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

## Patch unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | Patch

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Field | Description
--- | ---

## PersistentVolumeClaimVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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).

Appears In Volume

Field | Description
--- | ---
claimName string | ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims
readOnly boolean | Will force the ReadOnly setting in VolumeMounts. Default false.

## PhotonPersistentDiskVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
pdID string | ID that identifies Photon Controller persistent disk

## PodCondition v1

Group | Version | Kind
--- | --- | ---
Core | v1 | PodCondition

PodCondition contains details for the current condition of this pod.

Appears In PodStatus

Field | Description
--- | ---
lastProbeTime Time | Last time we probed the condition.
lastTransitionTime Time | Last time the condition transitioned from one status to another.
message string | Human-readable message indicating details about last transition.
reason string | Unique, one-word, CamelCase reason for the condition's last transition.
status string | Status is the status of the condition. Can be True, False, Unknown. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions
type string | Type is the type of the condition. Currently only Ready. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions

## PodSecurityContext v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In PodSpec

Field | Description
--- | ---

fsGroup
integer

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.

runAsNonRoot
boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

runAsUser integer | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
seLinuxOptions SELinuxOptions | The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
supplementalGroups integer array | A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.

## PolicyRule v1alpha1

Group | Version | Kind
--- | --- | ---
Core | v1alpha1 | 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.

Appears In ClusterRole Role

Field | Description
--- | ---
apiGroups string array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
attributeRestrictions RawExtension | AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.

nonResourceURLs
string array

NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

resourceNames string array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources string array | Resources is a list of resources this rule applies to. ResourceAll represents all resources.
verbs string array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

## Preconditions v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Preconditions

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

Appears In DeleteOptions

Field | Description
--- | ---
uid string | Specifies the target UID.

## Probe v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Appears In Container

Field | Description
--- | ---
exec ExecAction | One and only one of the following should be specified. Exec specifies the action to take.
failureThreshold integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
httpGet HTTPGetAction | HTTPGet specifies the http request to perform.
initialDelaySeconds integer | Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
periodSeconds integer | How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold integer | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
tcpSocket TCPSocketAction | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
timeoutSeconds integer | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

## Quantity resource

Group | Version | Kind
--- | --- | ---
Core | resource | Quantity

Appears In ResourceFieldSelector

Field | Description
--- | ---

## QuobyteVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | QuobyteVolumeSource

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
group string | Group to map volume access to Default is no group
readOnly boolean | ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registry string | Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
user string | User to map volume access to Defaults to serivceaccount user
volume string | Volume is a string that references an already created Quobyte volume by name.

## RBDVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#rbd
image string | The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
keyring string | Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
monitors string array | A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
pool string | The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.
readOnly boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
secretRef LocalObjectReference | SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
user string | The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

## RawExtension runtime

Group | Version | Kind
--- | --- | ---
Core | runtime | RawExtension

RawExtension is used to hold extensions in external versions.

To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.

// Internal package: type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.Object `json:"myPlugin"` } type PluginA struct { AOption string `json:"aOption"` }

// External package: type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.RawExtension `json:"myPlugin"` } type PluginA struct { AOption string `json:"aOption"` }

// On the wire, the JSON will look something like this: { "kind":"MyAPIObject", "apiVersion":"v1", "myPlugin": { "kind":"PluginA", "aOption":"foo", }, }

So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)

Appears In Event PolicyRule

Field | Description
--- | ---
Raw string | Raw is the underlying serialization of this object.

## ReplicaSetCondition v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | ReplicaSetCondition

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

Appears In ReplicaSetStatus

Field | Description
--- | ---
lastTransitionTime Time | The last time the condition transitioned from one status to another.
message string | A human readable message indicating details about the transition.
reason string | The reason for the condition's last transition.
status string | Status of the condition, one of True, False, Unknown.
type string | Type of replica set condition.

## ReplicationControllerCondition v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ReplicationControllerCondition

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

Appears In ReplicationControllerStatus

Field | Description
--- | ---
lastTransitionTime Time | The last time the condition transitioned from one status to another.
message string | A human readable message indicating details about the transition.
reason string | The reason for the condition's last transition.
status string | Status of the condition, one of True, False, Unknown.
type string | Type of replication controller condition.

## ResourceAttributes v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | ResourceAttributes

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

Appears In SelfSubjectAccessReviewSpec SubjectAccessReviewSpec

Field | Description
--- | ---
group string | Group is the API Group of the Resource. "*" means all.
name string | Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
namespace string | Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
resource string | Resource is one of the existing resource types. "*" means all.
subresource string | Subresource is one of the existing resource types. "" means none.
verb string | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
version string | Version is the API Version of the Resource. "*" means all.

## ResourceFieldSelector v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ResourceFieldSelector

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

Appears In DownwardAPIVolumeFile EnvVarSource

Field | Description
--- | ---
containerName string | Container name: required for volumes, optional for env vars
divisor Quantity | Specifies the output format of the exposed resources, defaults to "1"
resource string | Required: resource to select

## ResourceRequirements v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Appears In Container PersistentVolumeClaimSpec

Field | Description
--- | ---
limits object | Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests object | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

## RoleRef v1alpha1

Group | Version | Kind
--- | --- | ---
Core | v1alpha1 | RoleRef

RoleRef contains information that points to the role being used

Appears In ClusterRoleBinding RoleBinding

Field | Description
--- | ---
apiGroup string | APIGroup is the group for the resource being referenced
kind string | Kind is the type of resource being referenced
name string | Name is the name of resource being referenced

## RollbackConfig v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | RollbackConfig

Appears In DeploymentRollback DeploymentSpec

Field | Description
--- | ---
revision integer | The revision to rollback to. If set to 0, rollbck to the last revision.

## SELinuxOptions v1

Group | Version | Kind
--- | --- | ---
Core | v1 | SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Appears In PodSecurityContext SecurityContext

Field | Description
--- | ---
level string | Level is SELinux level label that applies to the container.
role string | Role is a SELinux role label that applies to the container.
type string | Type is a SELinux type label that applies to the container.
user string | User is a SELinux user label that applies to the container.

## Scale v1

Group | Version | Kind
--- | --- | ---
Core | v1 | Scale

Other api versions of this object exist: v1beta1

Scale represents a scaling request for a resource.

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.
spec ScaleSpec | defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
status ScaleStatus | current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.

## SecretKeySelector v1

Group | Version | Kind
--- | --- | ---
Core | v1 | SecretKeySelector

SecretKeySelector selects a key of a Secret.

Appears In EnvVarSource

Field | Description
--- | ---
key string | The key of the secret to select from. Must be a valid secret key.
name string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

## SecretVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | SecretVolumeSource

Adapts a Secret into a volume.

The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

Appears In Volume

Field | Description
--- | ---
defaultMode integer | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

items
KeyToPath array

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.

secretName string | Name of the secret in the pod's namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

## SecurityContext v1

Group | Version | Kind
--- | --- | ---
Core | v1 | 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.

Appears In Container

Field | Description
--- | ---
capabilities Capabilities | The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
privileged boolean | Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
readOnlyRootFilesystem boolean | Whether this container has a read-only root filesystem. Default is false.

runAsNonRoot
boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

runAsUser integer | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
seLinuxOptions SELinuxOptions | The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

## ServerAddressByClientCIDR unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | ServerAddressByClientCIDR

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

Appears In APIGroup APIVersions

Field | Description
--- | ---
clientCIDR string | The CIDR with which clients can match their IP to figure out the server address that they should use.
serverAddress string | Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

## ServicePort v1

Group | Version | Kind
--- | --- | ---
Core | v1 | ServicePort

ServicePort contains information on service's port.

Appears In ServiceSpec

Field | Description
--- | ---
name string | The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.
nodePort integer | The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: http://kubernetes.io/docs/user-guide/services#type--nodeport
port integer | The port that will be exposed by this service.
protocol string | The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.

targetPort
IntOrString

Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: http://kubernetes.io/docs/user-guide/services#defining-a-service

## Status unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | Status

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

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
code integer | Suggested HTTP return code for this status, 0 if not set.
details StatusDetails | Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
message string | A human-readable description of the status of this operation.
metadata ListMeta | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
reason string | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status string | Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

## StatusCause unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | StatusCause

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

Appears In StatusDetails

Field | Description
--- | ---

field
string

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"

message string | A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason string | A machine-readable description of the cause of the error. If this value is empty there is no information available.

## StatusDetails unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | 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.

Appears In Status

Field | Description
--- | ---
causes StatusCause array | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group string | The group attribute of the resource associated with the status StatusReason.
kind string | The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
name string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds integer | If specified, the time in seconds before the operation should be retried.

## Subject v1alpha1

Group | Version | Kind
--- | --- | ---
Core | v1alpha1 | 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.

Appears In ClusterRoleBinding RoleBinding

Field | Description
--- | ---
apiVersion string | APIVersion holds the API group and version of the referenced object.
kind string | Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name string | Name of the object being referenced.
namespace string | Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

## SubresourceReference v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | SubresourceReference

SubresourceReference contains enough information to let you inspect or modify the referred subresource.

Appears In HorizontalPodAutoscalerSpec

Field | Description
--- | ---
apiVersion string | API version of the referent
kind string | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
name string | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
subresource string | Subresource name of the referent

## TCPSocketAction v1

Group | Version | Kind
--- | --- | ---
Core | v1 | TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Appears In Handler Probe

Field | Description
--- | ---
port IntOrString | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

## Time unversioned

Group | Version | Kind
--- | --- | ---
Core | unversioned | Time

Appears In CertificateSigningRequestCondition ContainerStateRunning ContainerStateTerminated CronJobStatus DeploymentCondition Event HorizontalPodAutoscalerStatus JobCondition JobStatus NodeCondition ObjectMeta PodCondition PodStatus ReplicaSetCondition ReplicationControllerCondition

Field | Description
--- | ---

## UserInfo v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | UserInfo

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

Appears In TokenReviewStatus

Field | Description
--- | ---
extra object | Any additional information provided by the authenticator.
groups string array | The names of groups this user is a part of.
uid string | A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
username string | The name that uniquely identifies this user among all active users.

## VolumeMount v1

Group | Version | Kind
--- | --- | ---
Core | v1 | VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Appears In Container

Field | Description
--- | ---
mountPath string | Path within the container at which the volume should be mounted. Must not contain ':'.
name string | This must match the Name of a Volume.
readOnly boolean | Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
subPath string | Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

## VsphereVirtualDiskVolumeSource v1

Group | Version | Kind
--- | --- | ---
Core | v1 | VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

Appears In PersistentVolumeSpec Volume

Field | Description
--- | ---
fsType string | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
volumePath string | Path that identifies vSphere volume vmdk

# OLD API VERSIONS

This section contains older versions of resources shown above.

# Event versioned

Group | Version | Kind
--- | --- | ---
Core | versioned | Event

Other api versions of this object exist: v1

Event represents a single event to a watched resource.

Field | Description
--- | ---
object RawExtension | Object is: If Type is Added or Modified: the new state of the object. If Type is Deleted: the state of the object immediately before deletion. If Type is Error: api.Status is recommended; other types may make sense depending on context.
type string |

# HorizontalPodAutoscaler v1beta1

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | HorizontalPodAutoscaler

Other api versions of this object exist: v1

configuration of a horizontal pod autoscaler.

Appears In HorizontalPodAutoscalerList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec HorizontalPodAutoscalerSpec | behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
status HorizontalPodAutoscalerStatus | current information about the autoscaler.

### HorizontalPodAutoscalerSpec v1beta1

Appears In HorizontalPodAutoscaler

Field | Description
--- | ---
cpuUtilization CPUTargetUtilization | target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources.
maxReplicas integer | upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
minReplicas integer | lower limit for the number of pods that can be set by the autoscaler, default 1.
scaleRef SubresourceReference | reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec.

### HorizontalPodAutoscalerStatus v1beta1

Appears In HorizontalPodAutoscaler

Field | Description
--- | ---
currentCPUUtilizationPercentage integer | current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
currentReplicas integer | current number of replicas of pods managed by this autoscaler.
desiredReplicas integer | desired number of replicas of pods managed by this autoscaler.
lastScaleTime Time | last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
observedGeneration integer | most recent generation observed by this autoscaler.

### HorizontalPodAutoscalerList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items HorizontalPodAutoscaler array | list of horizontal pod autoscaler objects.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata.

# Job v1beta1

Group | Version | Kind
--- | --- | ---
Extensions | v1beta1 | Job

Other api versions of this object exist: v1 v2alpha1

Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead.

Appears In JobList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec JobSpec | Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status JobStatus | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### JobSpec v1beta1

Appears In Job

Field | Description
--- | ---
activeDeadlineSeconds integer | Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
autoSelector boolean | AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md

completions
integer

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs

parallelism integer | Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs
selector LabelSelector | Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template PodTemplateSpec | Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs

### JobStatus v1beta1

Appears In Job

Field | Description
--- | ---
active integer | Active is the number of actively running pods.
completionTime Time | CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
conditions JobCondition array | Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs
failed integer | Failed is the number of pods which reached Phase Failed.
startTime Time | StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
succeeded integer | Succeeded is the number of pods which reached Phase Succeeded.

### JobList v1beta1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Job array | Items is the list of Job.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# Job v2alpha1

Group | Version | Kind
--- | --- | ---
Batch | v2alpha1 | Job

Other api versions of this object exist: v1 v1beta1

Job represents the configuration of a single job.

Appears In JobList

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec JobSpec | Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status JobStatus | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

### JobSpec v2alpha1

Appears In Job JobTemplateSpec

Field | Description
--- | ---
activeDeadlineSeconds integer | Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

completions
integer

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs

manualSelector
boolean

ManualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md

parallelism integer | Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs
selector LabelSelector | Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
template PodTemplateSpec | Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs

### JobStatus v2alpha1

Appears In Job

Field | Description
--- | ---
active integer | Active is the number of actively running pods.
completionTime Time | CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
conditions JobCondition array | Conditions represent the latest available observations of an object's current state. More info: http://kubernetes.io/docs/user-guide/jobs
failed integer | Failed is the number of pods which reached Phase Failed.
startTime Time | StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
succeeded integer | Succeeded is the number of pods which reached Phase Succeeded.

### JobList v2alpha1

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Job array | Items is the list of Job.
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

# JobCondition v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | JobCondition

Other api versions of this object exist: v1 v2alpha1

JobCondition describes current state of a job.

Appears In JobStatus

Field | Description
--- | ---
lastProbeTime Time | Last time the condition was checked.
lastTransitionTime Time | Last time the condition transit from one status to another.
message string | Human readable message indicating details about last transition.
reason string | (brief) reason for the condition's last transition.
status string | Status of the condition, one of True, False, Unknown.
type string | Type of job condition, Complete or Failed.

# JobCondition v2alpha1

Group | Version | Kind
--- | --- | ---
Core | v2alpha1 | JobCondition

Other api versions of this object exist: v1 v1beta1

JobCondition describes current state of a job.

Appears In JobStatus

Field | Description
--- | ---
lastProbeTime Time | Last time the condition was checked.
lastTransitionTime Time | Last time the condition transit from one status to another.
message string | Human readable message indicating details about last transition.
reason string | (brief) reason for the condition's last transition.
status string | Status of the condition, one of True, False, Unknown.
type string | Type of job condition, Complete or Failed.

# Scale v1beta1

Group | Version | Kind
--- | --- | ---
Core | v1beta1 | Scale

Other api versions of this object exist: v1

represents a scaling request for a resource.

Field | Description
--- | ---
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta | Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.
spec ScaleSpec | defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.
status ScaleStatus | current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.

### ScaleSpec v1beta1

Appears In Scale

Field | Description
--- | ---
replicas integer | desired number of instances for the scaled object.

### ScaleStatus v1beta1

Appears In Scale

Field | Description
--- | ---
replicas integer | actual number of observed instances of the scaled object.
selector object | label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

targetSelector
string

label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors