Top Level API Objects
Definitions
v1.Node
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | specification of a node; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | ||
| status | most recently observed status of the node; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.PersistentVolumeClaimList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | ||
| items | a list of persistent volume claims; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims | false | v1.PersistentVolumeClaim array | 
v1.ObjectFieldSelector
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| apiVersion | version of the schema that fieldPath is written in terms of; defaults to v1 | false | string | |
| fieldPath | path of the field to select in the specified API version | true | string | 
v1.SELinuxOptions
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| user | the user label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md | false | string | |
| role | the role label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md | false | string | |
| type | the type label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md | false | string | |
| level | the level label to apply to the container; see http://releases.k8s.io/HEAD/docs/labels.md | false | string | 
v1.ContainerStateRunning
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| startedAt | time at which the container was last (re-)started | false | string | 
v1.VolumeMount
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | name of the volume to mount | true | string | |
| readOnly | mounted read-only if true, read-write otherwise (false or unspecified) | false | boolean | false | 
| mountPath | path within the container at which the volume should be mounted | true | string | 
v1.PersistentVolumeClaimSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| accessModes | the desired access modes the volume should have; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes-1 | false | ||
| resources | the desired resources the volume should have; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#resources | false | ||
| volumeName | the binding reference to the persistent volume backing this claim | false | string | 
v1.GCEPersistentDiskVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| pdName | unique name of the PD resource in GCE; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk | true | string | |
| fsType | file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk | true | string | |
| partition | partition on the disk to mount (e.g., 1 for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk | false | integer (int32) | |
| readOnly | read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk | false | boolean | false | 
v1.NamespaceStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| phase | phase is the current lifecycle phase of the namespace; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases | false | string | 
v1.ResourceQuotaSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| hard | hard is the set of desired hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota | false | 
v1.NamespaceSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| finalizers | an opaque list of values that must be empty to permanently remove object from storage; see http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers | false | v1.FinalizerName array | 
v1.PersistentVolume
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | specification of a persistent volume as provisioned by an administrator; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistent-volumes | false | ||
| status | current status of a persistent volume; populated by the system, read-only; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistent-volumes | false | 
v1.PersistentVolumeStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| phase | the current phase of a persistent volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#phase | false | string | |
| message | human-readable message indicating details about why the volume is in this state | false | string | |
| reason | (brief) reason the volume is not is not available | false | string | 
v1.EndpointsList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of endpoints | true | v1.Endpoints array | 
v1.GitRepoVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| repository | repository URL | true | string | |
| revision | commit hash for the specified revision | true | string | 
v1.Capabilities
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| add | added capabilities | false | v1.Capability array | |
| drop | droped capabilities | false | v1.Capability array | 
v1.NodeCondition
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| type | type of node condition, currently only Ready | true | string | |
| status | status of the condition, one of True, False, Unknown | true | string | |
| lastHeartbeatTime | last time we got an update on a given condition | false | string | |
| lastTransitionTime | last time the condition transit from one status to another | false | string | |
| reason | (brief) reason for the condition’s last transition | false | string | |
| message | human readable message indicating details about last transition | false | string | 
v1.PodTemplateList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of pod templates | true | v1.PodTemplate array | 
v1.LocalObjectReference
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | name of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#names | false | string | 
v1.ResourceQuotaStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| hard | hard is the set of enforced hard limits for each named resource; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota | false | ||
| used | used is the current observed total usage of the resource in the namespace | false | 
v1.ExecAction
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| command | command line to execute inside the container; working directory for the command is root (/) in the container’s file system; the command is exec’d, not run inside a shell; exit status of 0 is treated as live/healthy and non-zero is unhealthy | false | string array | 
v1.ObjectMeta
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | string that identifies an object. Must be unique within a namespace; cannot be updated; see http://releases.k8s.io/HEAD/docs/identifiers.md#names | false | string | |
| generateName | an optional prefix to use to generate a unique name; has the same validation rules as name; optional, and is applied only name if is not specified; see http://releases.k8s.io/HEAD/docs/api-conventions.md#idempotency | false | string | |
| namespace | namespace of the object; must be a DNS_LABEL; cannot be updated; see http://releases.k8s.io/HEAD/docs/namespaces.md | false | string | |
| selfLink | URL for the object; populated by the system, read-only | false | string | |
| uid | unique UUID across space and time; populated by the system; read-only; see http://releases.k8s.io/HEAD/docs/identifiers.md#uids | false | string | |
| resourceVersion | string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/api-conventions.md#concurrency-control-and-consistency | false | string | |
| generation | a sequence number representing a specific generation of the desired state; populated by the system; read-only | false | integer (int64) | |
| creationTimestamp | RFC 3339 date and time at which the object was created; populated by the system, read-only; null for lists; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | string | |
| deletionTimestamp | RFC 3339 date and time at which the object will be deleted; populated by the system when a graceful deletion is requested, read-only; if not set, graceful deletion of the object has not been requested; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | string | |
| labels | map of string keys and values that can be used to organize and categorize objects; may match selectors of replication controllers and services; see http://releases.k8s.io/HEAD/docs/labels.md | false | ||
| annotations | map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about objects; see http://releases.k8s.io/HEAD/docs/annotations.md | false | 
api.Patch
v1.LimitRangeSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| limits | limits is the list of LimitRangeItem objects that are enforced | true | v1.LimitRangeItem array | 
v1.ISCSIVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| targetPortal | iSCSI target portal | true | string | |
| iqn | iSCSI Qualified Name | true | string | |
| lun | iscsi target lun number | true | integer (int32) | |
| fsType | file system type to mount, such as ext4, xfs, ntfs | true | string | |
| readOnly | read-only if true, read-write otherwise (false or unspecified) | false | boolean | false | 
v1.EmptyDirVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| medium | type of storage used to back the volume; must be an empty string (default) or Memory; see http://releases.k8s.io/HEAD/docs/volumes.md#emptydir | false | string | 
v1.NodeList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of nodes | true | v1.Node array | 
v1.PersistentVolumeClaim
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | the desired characteristics of a volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims | false | ||
| status | the current status of a persistent volume claim; read-only; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims | false | 
v1.NamespaceList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | items is the list of Namespace objects in the list; see http://releases.k8s.io/HEAD/docs/namespaces.md | true | v1.Namespace array | 
v1.ServiceAccount
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| secrets | list of secrets that can be used by pods running as this service account; see http://releases.k8s.io/HEAD/docs/secrets.md | false | v1.ObjectReference array | |
| imagePullSecrets | list of references to secrets in the same namespace available for pulling container images; see http://releases.k8s.io/HEAD/docs/secrets.md#manually-specifying-an-imagepullsecret | false | v1.LocalObjectReference array | 
v1.NodeAddress
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| type | node address type, one of Hostname, ExternalIP or InternalIP | true | string | |
| address | the node address | true | string | 
v1.Namespace
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | spec defines the behavior of the Namespace; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | ||
| status | status describes the current status of a Namespace; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.ListMeta
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| selfLink | URL for the object; populated by the system, read-only | false | string | |
| resourceVersion | string that identifies the internal version of this object that can be used by clients to determine when objects have changed; populated by the system, read-only; value must be treated as opaque by clients and passed unmodified back to the server: http://releases.k8s.io/HEAD/docs/api-conventions.md#concurrency-control-and-consistency | false | string | 
v1.PersistentVolumeClaimVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| claimName | the name of the claim in the same namespace to be mounted as a volume; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims | true | string | |
| readOnly | mount volume as read-only when true; default false | false | boolean | false | 
v1.PersistentVolumeClaimStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| phase | the current phase of the claim | false | string | |
| accessModes | the actual access modes the volume has; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes-1 | false | ||
| capacity | the actual resources the volume has | false | 
v1.ResourceQuotaList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | items is a list of ResourceQuota objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota | true | v1.ResourceQuota array | 
v1.EndpointSubset
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| addresses | IP addresses which offer the related ports | false | v1.EndpointAddress array | |
| ports | port numbers available on the related IP addresses | false | v1.EndpointPort array | 
v1.SecretVolumeSource
| Name | Description | Required | Schema | Default | ||
|---|---|---|---|---|---|---|
| secretName | secretName is the name of a secret in the pod’s namespace; see http://releases.k8s.io/HEAD/docs/volumes.md#secrets | true | 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). | true | string | |
| iqn | Target iSCSI Qualified Name. | true | string | |||
| lun | iSCSI Target Lun number. | true | integer (int32) | |||
| iscsiInterface | iSCSI Interface Name that uses an iSCSI transport. Defaults to default (tcp). | false | string | |||
| fsType | 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: https://kubernetes.io/docs/concepts/storage/volumes#iscsi | false | string | |||
| readOnly | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. | false | boolean | false | ||
| portals | iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). | false | string array | |||
| chapAuthDiscovery | whether support iSCSI Discovery CHAP authentication | false | boolean | false | ||
| chapAuthSession | whether support iSCSI Session CHAP authentication | false | boolean | false | ||
| secretRef | CHAP Secret for iSCSI target and initiator authentication | false | ||||
| initiatorName | Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. | false | string | 
v1.EnvVarSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| fieldRef | selects a field of the pod; only name and namespace are supported | true | 
v1.LoadBalancerIngress
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| ip | IP address of ingress point | false | string | |
| hostname | hostname of ingress point | false | string | 
v1.Service
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | specification of the desired behavior of the service; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | ||
| status | most recently observed status of the service; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.ServiceAccountList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of ServiceAccounts; see http://releases.k8s.io/HEAD/docs/service_accounts.md#service-accounts | true | v1.ServiceAccount array | 
v1.LimitRangeList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | items is a list of LimitRange objects; see http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md | true | v1.LimitRange array | 
v1.Endpoints
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| subsets | sets of addresses and ports that comprise a service | true | v1.EndpointSubset array | 
v1.DeleteOptions
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| gracePeriodSeconds | the duration in seconds to wait before deleting this object; defaults to a per object value if not specified; zero means delete immediately | true | integer (int64) | 
v1.Volume
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | volume name; must be a DNS_LABEL and unique within the pod; see http://releases.k8s.io/HEAD/docs/identifiers.md#names | true | string | |
| hostPath | pre-existing host file or directory; generally for privileged system daemons or other agents tied to the host; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath | false | ||
| emptyDir | temporary directory that shares a pod’s lifetime; see http://releases.k8s.io/HEAD/docs/volumes.md#emptydir | false | ||
| gcePersistentDisk | GCE disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk | false | ||
| awsElasticBlockStore | AWS disk resource attached to the host machine on demand; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore | false | ||
| gitRepo | git repository at a particular revision | false | ||
| secret | secret to populate volume; see http://releases.k8s.io/HEAD/docs/volumes.md#secrets | false | ||
| nfs | NFS volume that will be mounted in the host machine; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs | false | ||
| iscsi | iSCSI disk attached to host machine on demand; see http://releases.k8s.io/HEAD/examples/iscsi/README.md | false | ||
| glusterfs | Glusterfs volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md | false | ||
| persistentVolumeClaim | a reference to a PersistentVolumeClaim in the same namespace; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#persistentvolumeclaims | false | ||
| rbd | rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md | false | 
v1.Probe
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| exec | exec-based handler | false | ||
| httpGet | HTTP-based handler | false | ||
| tcpSocket | TCP-based handler; TCP hooks not yet supported | false | ||
| initialDelaySeconds | number of seconds after the container has started before liveness probes are initiated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes | false | integer (int64) | |
| timeoutSeconds | number of seconds after which liveness probes timeout; defaults to 1 second; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes | false | integer (int64) | 
v1.Capability
v1.ReplicationController
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | specification of the desired behavior of the replication controller; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | ||
| status | most recently observed status of the replication controller; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.LimitRange
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | spec defines the limits enforced; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.PodStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| phase | current condition of the pod; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-phase | false | string | |
| conditions | current service state of pod; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions | false | v1.PodCondition array | |
| message | human readable message indicating details about why the pod is in this condition | false | string | |
| reason | (brief-CamelCase) reason indicating details about why the pod is in this condition | false | string | |
| hostIP | IP address of the host to which the pod is assigned; empty if not yet scheduled | false | string | |
| podIP | IP address allocated to the pod; routable at least within the cluster; empty if not yet allocated | false | string | |
| startTime | 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. | false | string | |
| containerStatuses | list of container statuses; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-statuses | false | v1.ContainerStatus array | 
v1.PodSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| volumes | list of volumes that can be mounted by containers belonging to the pod; see http://releases.k8s.io/HEAD/docs/volumes.md | false | v1.Volume array | |
| containers | list of containers belonging to the pod; cannot be updated; containers cannot currently be added or removed; there must be at least one container in a Pod; see http://releases.k8s.io/HEAD/docs/containers.md | true | v1.Container array | |
| restartPolicy | restart policy for all containers within the pod; one of Always, OnFailure, Never; defaults to Always; see http://releases.k8s.io/HEAD/docs/pod-states.md#restartpolicy | false | string | |
| terminationGracePeriodSeconds | 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 not set, 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 | false | integer (int64) | |
| activeDeadlineSeconds | false | integer (int64) | ||
| dnsPolicy | DNS policy for containers within the pod; one of ClusterFirst or Default | false | string | |
| nodeSelector | selector which must match a node’s labels for the pod to be scheduled on that node; see http://releases.k8s.io/HEAD/examples/node-selection/README.md | false | ||
| serviceAccountName | name of the ServiceAccount to use to run this pod; see http://releases.k8s.io/HEAD/docs/service_accounts.md | false | string | |
| nodeName | node requested for this pod | false | string | |
| hostNetwork | host networking requested for this pod | false | boolean | false | 
| imagePullSecrets | list of references to secrets in the same namespace available for pulling the container images; see http://releases.k8s.io/HEAD/docs/images.md#specifying-imagepullsecrets-on-a-pod | false | v1.LocalObjectReference array | 
v1.ContainerPort
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | name for the port that can be referred to by services; must be an IANA_SVC_NAME and unique within the pod | false | string | |
| hostPort | number of port to expose on the host; most containers do not need this | false | integer (int32) | |
| containerPort | number of port to expose on the pod’s IP address | true | integer (int32) | |
| protocol | protocol for port; must be UDP or TCP; TCP if unspecified | false | string | |
| hostIP | host IP to bind the port to | false | string | 
v1.EventList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of events | true | v1.Event array | 
v1.ResourceQuota
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | spec defines the desired quota; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | ||
| status | status defines the actual enforced quota and current usage; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.Lifecycle
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| postStart | called immediately after a container is started; 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; see http://releases.k8s.io/HEAD/docs/container-environment.md#hook-details | false | ||
| preStop | called before a container is terminated; the container is terminated after the handler completes; other management of the container blocks until the hook completes; see http://releases.k8s.io/HEAD/docs/container-environment.md#hook-details | false | 
v1.NodeStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| capacity | compute resource capacity of the node; see http://releases.k8s.io/HEAD/docs/compute_resources.md | false | ||
| phase | most recently observed lifecycle phase of the node; see http://releases.k8s.io/HEAD/docs/node.md#node-phase | false | string | |
| conditions | list of node conditions observed; see http://releases.k8s.io/HEAD/docs/node.md#node-condition | false | v1.NodeCondition array | |
| addresses | list of addresses reachable to the node; see http://releases.k8s.io/HEAD/docs/node.md#node-addresses | false | v1.NodeAddress array | |
| nodeInfo | set of ids/uuids to uniquely identify the node; see http://releases.k8s.io/HEAD/docs/node.md#node-info | false | 
v1.GlusterfsVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| endpoints | gluster hosts endpoints name; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | true | string | |
| path | path to gluster volume; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | true | string | |
| readOnly | glusterfs volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod | false | boolean | false | 
v1.Handler
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| exec | exec-based handler | false | ||
| httpGet | HTTP-based handler | false | ||
| tcpSocket | TCP-based handler; TCP hooks not yet supported | false | 
v1.ReplicationControllerSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| replicas | number of replicas desired; defaults to 1; see http://releases.k8s.io/HEAD/docs/replication-controller.md#what-is-a-replication-controller | false | integer (int32) | |
| selector | label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template; see http://releases.k8s.io/HEAD/docs/labels.md#label-selectors | false | ||
| template | object that describes the pod that will be created if insufficient replicas are detected; takes precedence over templateRef; see http://releases.k8s.io/HEAD/docs/replication-controller.md#pod-template | false | 
v1.EventSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| component | component that generated the event | false | string | |
| host | name of the host where the event is generated | false | string | 
v1.StatusCause
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| reason | machine-readable description of the cause of the error; if this value is empty there is no information available | false | string | |
| message | human-readable description of the cause of the error; this field may be presented as-is to a reader | false | string | |
| field | 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 | false | string | 
v1.PodCondition
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| type | kind of the condition, currently only Ready; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions | true | string | |
| status | status of the condition, one of True, False, Unknown; see http://releases.k8s.io/HEAD/docs/pod-states.md#pod-conditions | true | string | 
v1.RBDVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| monitors | a collection of Ceph monitors; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string array | |
| image | rados image name; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
| fsType | file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | false | string | |
| pool | rados pool name; default is rbd; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
| user | rados user name; default is admin; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
| keyring | keyring is the path to key ring for rados user; default is /etc/ceph/keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | string | |
| secretRef | name of a secret to authenticate the RBD user; if provided overrides keyring; optional; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | true | ||
| readOnly | rbd volume to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it | false | boolean | false | 
v1.Status
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| status | status of the operation; either Success, or Failure; see http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | string | |
| message | human-readable description of the status of this operation | false | string | |
| reason | 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 | false | string | |
| details | 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 | false | ||
| code | suggested HTTP return code for this status; 0 if not set | false | integer (int32) | 
v1.PodTemplate
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| template | the template of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.ServiceStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| loadBalancer | status of load-balancer | false | 
v1.NFSVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| server | the hostname or IP address of the NFS server; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs | true | string | |
| path | the path that is exported by the NFS server; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs | true | string | |
| readOnly | forces the NFS export to be mounted with read-only permissions; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs | false | boolean | false | 
v1.EndpointPort
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | name of this port | false | string | |
| port | port number of the endpoint | true | integer (int32) | |
| protocol | protocol for this port; must be UDP or TCP; TCP if unspecified | false | string | 
v1.TCPSocketAction
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| port | 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 | true | string | 
v1.HTTPGetAction
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| path | path to access on the HTTP server | false | string | |
| port | 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 | true | string | |
| host | hostname to connect to; defaults to pod IP | false | string | |
| scheme | scheme to connect with, must be HTTP or HTTPS, defaults to HTTP | false | string | 
v1.StatusDetails
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | the name attribute of the resource associated with the status StatusReason (when there is a single name which can be described) | false | string | |
| kind | the kind attribute of the resource associated with the status StatusReason; on some operations may differ from the requested resource Kind; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| causes | the Causes array includes more details associated with the StatusReason failure; not all StatusReasons may provide detailed causes | false | v1.StatusCause array | |
| retryAfterSeconds | the number of seconds before the client should attempt to retry this operation | false | integer (int32) | 
v1.LoadBalancerStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| ingress | load-balancer ingress points | false | v1.LoadBalancerIngress array | 
v1.SecretList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | items is a list of secret objects; see http://releases.k8s.io/HEAD/docs/secrets.md | true | v1.Secret array | 
v1.Container
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated | true | string | |
| image | Docker image name; see http://releases.k8s.io/HEAD/docs/images.md | false | string | |
| command | entrypoint array; not executed within a shell; the docker image’s entrypoint is used if this is not provided; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s 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; see http://releases.k8s.io/HEAD/docs/containers.md#containers-and-commands | false | string array | |
| args | command array; the docker image’s cmd is used if this is not provided; arguments to the entrypoint; cannot be updated; variable references $(VAR_NAME) are expanded using the container’s 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; see http://releases.k8s.io/HEAD/docs/containers.md#containers-and-commands | false | string array | |
| workingDir | container’s working directory; defaults to image’s default; cannot be updated | false | string | |
| ports | list of ports to expose from the container; cannot be updated | false | v1.ContainerPort array | |
| env | list of environment variables to set in the container; cannot be updated | false | v1.EnvVar array | |
| resources | Compute Resources required by this container; cannot be updated; see http://releases.k8s.io/HEAD/docs/compute_resources.md | false | ||
| volumeMounts | pod volumes to mount into the container’s filesyste; cannot be updated | false | v1.VolumeMount array | |
| livenessProbe | periodic probe of container liveness; container will be restarted if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes | false | ||
| readinessProbe | periodic probe of container service readiness; container will be removed from service endpoints if the probe fails; cannot be updated; see http://releases.k8s.io/HEAD/docs/pod-states.md#container-probes | false | ||
| lifecycle | actions that the management system should take in response to container lifecycle events; cannot be updated | false | ||
| terminationMessagePath | 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 | false | string | |
| imagePullPolicy | image pull policy; one of Always, Never, IfNotPresent; defaults to Always if :latest tag is specified, or IfNotPresent otherwise; cannot be updated; see http://releases.k8s.io/HEAD/docs/images.md#updating-images | false | string | |
| securityContext | security options the pod should run with; see http://releases.k8s.io/HEAD/docs/security_context.md | false | 
v1.PersistentVolumeSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| capacity | a description of the persistent volume’s resources and capacityr; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#capacity | false | ||
| gcePersistentDisk | GCE disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#gcepersistentdisk | false | ||
| awsElasticBlockStore | AWS disk resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore | false | ||
| hostPath | a HostPath provisioned by a developer or tester; for development use only; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath | false | ||
| glusterfs | Glusterfs volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/examples/glusterfs/README.md | false | ||
| nfs | NFS volume resource provisioned by an admin; see http://releases.k8s.io/HEAD/docs/volumes.md#nfs | false | ||
| rbd | rados block volume that will be mounted on the host machine; see http://releases.k8s.io/HEAD/examples/rbd/README.md | false | ||
| iscsi | an iSCSI disk resource provisioned by an admin | false | ||
| accessModes | all ways the volume can be mounted; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#access-modes | false | ||
| claimRef | when bound, a reference to the bound claim; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md#binding | false | ||
| persistentVolumeReclaimPolicy | what happens to a volume when released from its claim; Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume. See http://releases.k8s.io/HEAD/docs/persistent-volumes.md#recycling-policy | false | string | 
v1.ReplicationControllerStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| replicas | most recently oberved number of replicas; see http://releases.k8s.io/HEAD/docs/replication-controller.md#what-is-a-replication-controller | true | integer (int32) | |
| observedGeneration | reflects the generation of the most recently observed replication controller | false | integer (int64) | 
v1.FinalizerName
v1.ServicePort
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | the name of this port; optional if only one port is defined | false | string | |
| protocol | the protocol used by this port; must be UDP or TCP; TCP if unspecified | false | string | |
| port | the port number that is exposed | true | integer (int32) | |
| targetPort | number or name of the port to access on the pods targeted by the service; defaults to the service port; number must be in the range 1 to 65535; name must be an IANA_SVC_NAME; see http://releases.k8s.io/HEAD/docs/services.md#defining-a-service | false | string | |
| nodePort | 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; see http://releases.k8s.io/HEAD/docs/services.md#type—nodeport | true | integer (int32) | 
v1.ComponentCondition
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| type | type of component condition, currently only Healthy | true | string | |
| status | current status of this component condition, one of True, False, Unknown | true | string | |
| message | health check message received from the component | false | string | |
| error | error code from health check attempt (if any) | false | string | 
v1.ComponentStatusList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of component status objects | true | v1.ComponentStatus array | 
v1.HostPathVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| path | path of the directory on the host; see http://releases.k8s.io/HEAD/docs/volumes.md#hostpath | true | string | 
json.WatchEvent
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| type | the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR | false | string | |
| object | the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR | false | string | 
v1.Binding
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| target | an object to bind to | true | 
v1.ContainerStateTerminated
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| exitCode | exit status from the last termination of the container | true | integer (int32) | |
| signal | signal from the last termination of the container | false | integer (int32) | |
| reason | (brief) reason from the last termination of the container | false | string | |
| message | message regarding the last termination of the container | false | string | |
| startedAt | time at which previous execution of the container started | false | string | |
| finishedAt | time at which the container last terminated | false | string | |
| containerID | container’s ID in the format docker://<container_id> | false | string | 
v1.SecurityContext
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| capabilities | the linux capabilites that should be added or removed; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context | false | ||
| privileged | run the container in privileged mode; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context | false | boolean | false | 
| seLinuxOptions | options that control the SELinux labels applied; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context | false | ||
| runAsUser | the user id that runs the first process in the container; see http://releases.k8s.io/HEAD/docs/design/security_context.md#security-context | false | integer (int64) | 
v1.ContainerState
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| waiting | details about a waiting container | false | ||
| running | details about a running container | false | ||
| terminated | details about a terminated container | false | 
v1.AWSElasticBlockStoreVolumeSource
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| volumeID | unique id of the PD resource in AWS; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore | true | string | |
| fsType | file system type to mount, such as ext4, xfs, ntfs; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore | true | string | |
| partition | partition on the disk to mount (e.g., 1 for /dev/sda1); if omitted the plain device name (e.g., /dev/sda) will be mounted; see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore | false | integer (int32) | |
| readOnly | read-only if true, read-write otherwise (false or unspecified); see http://releases.k8s.io/HEAD/docs/volumes.md#awselasticblockstore | false | boolean | false | 
v1.ContainerStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated | true | string | |
| state | details about the container’s current condition | false | ||
| lastState | details about the container’s last termination condition | false | ||
| ready | specifies whether the container has passed its readiness probe | true | boolean | false | 
| restartCount | the number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed | true | integer (int32) | |
| image | image of the container; see http://releases.k8s.io/HEAD/docs/images.md | true | string | |
| imageID | ID of the container’s image | true | string | |
| containerID | container’s ID in the format docker://<container_id>; see http://releases.k8s.io/HEAD/docs/container-environment.md#container-information | false | string | 
v1.ReplicationControllerList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of replication controllers; see http://releases.k8s.io/HEAD/docs/replication-controller.md | true | v1.ReplicationController array | 
v1.Secret
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| data | data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. Each value must be a base64 encoded string as described in https://tools.ietf.org/html/rfc4648#section-4 | false | ||
| type | type facilitates programmatic handling of secret data | false | string | 
v1.Event
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | true | ||
| involvedObject | object this event is about | true | ||
| reason | short, machine understandable string that gives the reason for the transition into the object’s current status | false | string | |
| message | human-readable description of the status of this operation | false | string | |
| source | component reporting this event | false | ||
| firstTimestamp | the time at which the event was first recorded | false | string | |
| lastTimestamp | the time at which the most recent occurrence of this event was recorded | false | string | |
| count | the number of times this event has occurred | false | integer (int32) | 
v1.EnvVar
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| name | name of the environment variable; must be a C_IDENTIFIER | true | string | |
| value | value of the environment variable; defaults to empty string; variable references $(VAR_NAME) are expanded using the previously defined environment varibles 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 | false | string | |
| valueFrom | source for the environment variable’s value; cannot be used if value is not empty | false | 
v1.ResourceRequirements
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| limits | Maximum amount of compute resources allowed; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications | false | ||
| requests | Minimum amount of resources requested; requests are honored only for persistent volumes as of now; see http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications | false | 
v1.PersistentVolumeAccessMode
v1.ComponentStatus
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| conditions | list of component conditions observed | false | v1.ComponentCondition array | 
v1.LimitRangeItem
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| type | type of resource that this limit applies to | false | string | |
| max | max usage constraints on this kind by resource name | false | ||
| min | min usage constraints on this kind by resource name | false | ||
| default | default values on this kind by resource name if omitted | false | 
v1.PodTemplateSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | specification of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.PodList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | ||
| items | list of pods; see http://releases.k8s.io/HEAD/docs/pods.md | true | v1.Pod array | 
v1.ServiceList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| items | list of services | true | v1.Service array | 
v1.PersistentVolumeList
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard list metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | ||
| items | list of persistent volumes; see http://releases.k8s.io/HEAD/docs/persistent-volumes.md | false | v1.PersistentVolume array | 
v1.ObjectReference
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of the referent; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| namespace | namespace of the referent; see http://releases.k8s.io/HEAD/docs/namespaces.md | false | string | |
| name | name of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#names | false | string | |
| uid | uid of the referent; see http://releases.k8s.io/HEAD/docs/identifiers.md#uids | false | string | |
| apiVersion | API version of the referent | false | string | |
| resourceVersion | specific resourceVersion to which this reference is made, if any: http://releases.k8s.io/HEAD/docs/api-conventions.md#concurrency-control-and-consistency | false | string | |
| fieldPath | 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] | false | string | 
v1.ContainerStateWaiting
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| reason | (brief) reason the container is not yet running, such as pulling its image | false | string | 
v1.NodeSystemInfo
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| machineID | machine-id reported by the node | true | string | |
| systemUUID | system-uuid reported by the node | true | string | |
| bootID | boot id is the boot-id reported by the node | true | string | |
| kernelVersion | Kernel version reported by the node from uname -r (e.g. 3.16.0-0.bpo.4-amd64) | true | string | |
| osImage | OS image used reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)) | true | string | |
| containerRuntimeVersion | Container runtime version reported by the node through runtime remote API (e.g. docker://1.5.0) | true | string | |
| kubeletVersion | Kubelet version reported by the node | true | string | |
| kubeProxyVersion | Kube-proxy version reported by the node | true | string | 
v1.ServiceSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| ports | ports exposed by the service; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies | true | v1.ServicePort array | |
| selector | label keys and values that must match in order to receive traffic for this service; if empty, all pods are selected, if not specified, endpoints must be manually specified; see http://releases.k8s.io/HEAD/docs/services.md#overview | false | ||
| clusterIP | IP address of the service; usually assigned by the system; if specified, it will be allocated to the service if unused or else creation of the service will fail; cannot be updated; None can be specified for a headless service when proxying is not required; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies | false | string | |
| type | type of this service; must be ClusterIP, NodePort, or LoadBalancer; defaults to ClusterIP; see http://releases.k8s.io/HEAD/docs/services.md#external-services | false | string | |
| deprecatedPublicIPs | deprecated. externally visible IPs (e.g. load balancers) that should be proxied to this service | false | string array | |
| sessionAffinity | enable client IP based session affinity; must be ClientIP or None; defaults to None; see http://releases.k8s.io/HEAD/docs/services.md#virtual-ips-and-service-proxies | false | string | 
v1.Pod
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| kind | kind of object, in CamelCase; cannot be updated; see http://releases.k8s.io/HEAD/docs/api-conventions.md#types-kinds | false | string | |
| apiVersion | version of the schema the object should have; see http://releases.k8s.io/HEAD/docs/api-conventions.md#resources | false | string | |
| metadata | standard object metadata; see http://releases.k8s.io/HEAD/docs/api-conventions.md#metadata | false | ||
| spec | specification of the desired behavior of the pod; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | ||
| status | most recently observed status of the pod; populated by the system, read-only; http://releases.k8s.io/HEAD/docs/api-conventions.md#spec-and-status | false | 
v1.NodeSpec
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| podCIDR | pod IP range assigned to the node | false | string | |
| externalID | deprecated. External ID assigned to the node by some machine database (e.g. a cloud provider). Defaults to node name when empty. | false | string | |
| providerID | ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> | false | string | |
| unschedulable | disable pod scheduling on the node; see http://releases.k8s.io/HEAD/docs/node.md#manual-node-administration | false | boolean | false | 
v1.EndpointAddress
| Name | Description | Required | Schema | Default | 
|---|---|---|---|---|
| ip | IP address of the endpoint | true | string | |
| targetRef | reference to object providing the endpoint | false | 
any
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.