k8s api object

Top Level API Objects

  • v1.Pod

  • v1.PodList

  • v1.PodTemplate

  • v1.PodTemplateList

  • v1.ReplicationController

  • v1.ReplicationControllerList

  • v1.Service

  • v1.ServiceList

  • v1.Endpoints

  • v1.EndpointsList

  • v1.Node

  • v1.NodeList

  • v1.Binding

  • v1.Event

  • v1.EventList

  • v1.LimitRange

  • v1.LimitRangeList

  • v1.ResourceQuota

  • v1.ResourceQuotaList

  • v1.Namespace

  • v1.NamespaceList

  • v1.Secret

  • v1.SecretList

  • v1.ServiceAccount

  • v1.ServiceAccountList

  • v1.PersistentVolume

  • v1.PersistentVolumeList

  • v1.PersistentVolumeClaim

  • v1.PersistentVolumeClaimList

  • v1.DeleteOptions

  • v1.ComponentStatus

  • v1.ComponentStatusList

  • v1.ConfigMap

  • v1.ConfigMapList

Definitions

v1.Node

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines the behavior of a node.http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.NodeSpec

 

status

Most recently observed status of the node. Populated by the system. Read-only. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.NodeStatus

 

v1.PersistentVolumeClaimList

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

A list of persistent volume claims. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true

v1.PersistentVolumeClaimarray

 

v1.Preconditions

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

Name Description Required Schema Default

uid

Specifies the target UID.

false

types.UID

 

v1.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Name Description Required Schema Default

user

User is a SELinux user label that applies to the container.

false

string

 

role

Role is a SELinux role label that applies to the container.

false

string

 

type

Type is a SELinux type label that applies to the container.

false

string

 

level

Level is SELinux level label that applies to the container.

false

string

 

v1.ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Name Description Required Schema Default

apiVersion

Version of the schema the 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.ContainerStateRunning

ContainerStateRunning is a running state of a container.

Name Description Required Schema Default

startedAt

Time at which the container was last (re-)started

false

string

 

v1.VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Name Description Required Schema Default

name

This must match the Name of a Volume.

true

string

 

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

false

boolean

false

mountPath

Path within the container at which the volume should be mounted. Must not contain :.

true

string

 

subPath

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

false

string

 

v1.PersistentVolumeClaimSpec

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

Name Description Required Schema Default

accessModes

AccessModes contains the desired access modes the volume should have. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#access-modes-1

false

v1.PersistentVolumeAccessModearray

 

selector

A label query over volumes to consider for binding.

false

unversioned.LabelSelector

 

resources

Resources represents the minimum resources the volume should have. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

 

volumeName

VolumeName is the binding reference to the PersistentVolume backing this claim.

false

string

 

v1.CephFSVolumeSource

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

Name Description Required Schema Default

monitors

Required: Monitors is a collection of Ceph monitors More info:http://releases.k8s.io/release-1.3/examples/cephfs/README.md#how-to-use-it

true

string array

 

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

string

 

user

Optional: User is the rados user name, default is admin More info:http://releases.k8s.io/release-1.3/examples/cephfs/README.md#how-to-use-it

false

string

 

secretFile

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/release-1.3/examples/cephfs/README.md#how-to-use-it

false

string

 

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info:http://releases.k8s.io/release-1.3/examples/cephfs/README.md#how-to-use-it

false

v1.LocalObjectReference

 

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info:http://releases.k8s.io/release-1.3/examples/cephfs/README.md#how-to-use-it

false

boolean

false

v1.DownwardAPIVolumeSource

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

Name Description Required Schema Default

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFilearray

 

unversioned.StatusCause

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

Name Description Required Schema Default

reason

A machine-readable description of the cause of the error. If this value is empty there is no information available.

false

string

 

message

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

false

string

 

field

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"

false

string

 

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.

Name Description Required Schema Default

pdName

Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

true

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:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

string

 

partition

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://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

 

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

boolean

false

v1.ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Name Description Required Schema Default

hard

Hard is the set of desired hard limits for each named resource. More info:http://releases.k8s.io/release-1.3/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

object

 

scopes

A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

false

v1.ResourceQuotaScopearray

 

v1.NamespaceStatus

NamespaceStatus is information about the current status of a Namespace.

Name Description Required Schema Default

phase

Phase is the current lifecycle phase of the namespace. More info:http://releases.k8s.io/release-1.3/docs/design/namespaces.md#phases

false

string

 

v1.NamespaceSpec

NamespaceSpec describes the attributes on a Namespace.

Name Description Required Schema Default

finalizers

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

false

v1.FinalizerNamearray

 

v1.PersistentVolume

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistent-volumes

false

v1.PersistentVolumeSpec

 

status

Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistent-volumes

false

v1.PersistentVolumeStatus

 

v1.ConfigMapList

ConfigMapList is a resource containing a list of ConfigMap objects.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

 

items

Items is the list of ConfigMaps.

true

v1.ConfigMap array

 

v1.PersistentVolumeStatus

PersistentVolumeStatus is the current status of a persistent volume.

Name Description Required Schema Default

phase

Phase indicates if a volume is available, bound to a claim, or released by a claim. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#phase

false

string

 

message

A human-readable message indicating details about why the volume is in this state.

false

string

 

reason

Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

false

string

 

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.

Name Description Required Schema Default

name

Name of the referent. More info:http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

false

string

 

items

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

false

v1.KeyToPath array

 

*versioned.Event

v1.EndpointsList

EndpointsList is a list of endpoints.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

List of endpoints.

true

v1.Endpoints array

 

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.

Name Description Required Schema Default

repository

Repository URL

true

string

 

revision

Commit hash for the specified revision.

false

string

 

directory

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.

false

string

 

v1.ScaleStatus

ScaleStatus represents the current status of a scale subresource.

Name Description Required Schema Default

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

 

selector

label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors:http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

string

 

v1.Capabilities

Adds and removes POSIX capabilities from running containers.

Name Description Required Schema Default

add

Added capabilities

false

v1.Capability array

 

drop

Removed capabilities

false

v1.Capability array

 

v1.ConfigMap

ConfigMap holds configuration data for pods to consume.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

data

Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.

false

object

 

v1.PodTemplateList

PodTemplateList is a list of PodTemplates.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

List of pod templates

true

v1.PodTemplate array

 

v1.NodeCondition

NodeCondition contains condition infromation for a node.

Name Description Required Schema Default

type

Type of node condition.

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

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

Name Description Required Schema Default

name

Name of the referent. More info:http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

false

string

 

v1.ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

Name Description Required Schema Default

hard

Hard is the set of enforced hard limits for each named resource. More info:http://releases.k8s.io/release-1.3/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

object

 

used

Used is the current observed total usage of the resource in the namespace.

false

object

 

v1.ExecAction

ExecAction describes a "run in container" action.

Name Description Required Schema Default

command

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.

false

string array

v1.ObjectMeta

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

Name Description Required Schema Default

name

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://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

false

string

 

generateName

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/release-1.3/docs/devel/api-conventions.md#idempotency

false

string

 

namespace

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://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

false

string

 

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

 

uid

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://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

false

string

 

resourceVersion

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/release-1.3/docs/devel/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

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/release-1.3/docs/devel/api-conventions.md#metadata

false

string

 

deletionTimestamp

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 will 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. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. 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/release-1.3/docs/devel/api-conventions.md#metadata

false

string

 

deletionGracePeriodSeconds

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.

false

integer (int64)

 

labels

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://releases.k8s.io/release-1.3/docs/user-guide/labels.md

false

object

 

annotations

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://releases.k8s.io/release-1.3/docs/user-guide/annotations.md

false

object

 

ownerReferences

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.

false

v1.OwnerReferencearray

 

finalizers

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.

false

string array

 

v1.LimitRangeSpec

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

Name Description Required Schema Default

limits

Limits is the list of LimitRangeItem objects that are enforced.

true

v1.LimitRangeItemarray

 

types.UID

v1.AzureFileVolumeSource

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

Name Description Required Schema Default

secretName

the name of secret that contains Azure Storage Account Name and Key

true

string

 

shareName

Share Name

true

string

 

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

v1.ISCSIVolumeSource

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

Name Description Required Schema Default

targetPortal

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

Optional: Defaults to default(tcp). iSCSI interface name that uses an iSCSI transport.

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:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#iscsi

false

string

 

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

false

v1.EmptyDirVolumeSource

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

Name Description Required Schema Default

medium

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://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#emptydir

false

string

 

v1.NodeList

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

List of nodes

true

v1.Node array

 

unversioned.Patch

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

v1.NamespaceList

NamespaceList is a list of Namespaces.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

Items is the list of Namespace objects in the list. More info:http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

true

v1.Namespace array

 

v1.PersistentVolumeClaim

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines the desired characteristics of a volume requested by a pod author. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

v1.PersistentVolumeClaimSpec

 

status

Status represents the current information/status of a persistent volume claim. Read-only. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

v1.PersistentVolumeClaimStatus

 

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

secrets

Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info:http://releases.k8s.io/release-1.3/docs/user-guide/secrets.md

false

v1.ObjectReferencearray

 

imagePullSecrets

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://releases.k8s.io/release-1.3/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

false

v1.LocalObjectReferencearray

 

v1.NodeAddress

NodeAddress contains information for the node’s address.

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

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines the behavior of the Namespace. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.NamespaceSpec

 

status

Status describes the current status of a Namespace. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.NamespaceStatus

 

v1.FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.

Name Description Required Schema Default

datasetName

Required: the volume name. This is going to be store on metadata → name on the payload for Flocker

true

string

 

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

Name Description Required Schema Default

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true

string

 

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

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

Name Description Required Schema Default

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

 

resourceVersion

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/release-1.3/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

 

v1.ResourceQuotaList

ResourceQuotaList is a list of ResourceQuota items.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

Items is a list of ResourceQuota objects. More info:http://releases.k8s.io/release-1.3/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

true

v1.ResourceQuotaarray

 

v1.PersistentVolumeClaimStatus

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Name Description Required Schema Default

phase

Phase represents the current phase of PersistentVolumeClaim.

false

string

 

accessModes

AccessModes contains the actual access modes the volume backing the PVC has. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#access-modes-1

false

v1.PersistentVolumeAccessModearray

 

capacity

Represents the actual resources of the underlying volume.

false

object

 

v1.UniqueVolumeName

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.

Name Description Required Schema Default

matchLabels

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.

false

object

 

matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

unversioned.LabelSelectorRequirementarray

 

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 ]

Name Description Required Schema Default

addresses

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.

false

v1.EndpointAddressarray

 

notReadyAddresses

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.

false

v1.EndpointAddressarray

 

ports

Port numbers available on the related IP addresses.

false

v1.EndpointPort array

 

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.

Name Description Required Schema Default

secretName

Name of the secret in the pod’s namespace to use. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#secrets

false

string

 

items

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

false

v1.KeyToPath array

 

v1.FlexVolumeSource

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

Name Description Required Schema Default

driver

Driver is the name of the driver to use for this volume.

true

string

 

fsType

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.

false

string

 

secretRef

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.

false

v1.LocalObjectReference

 

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

options

Optional: Extra command options if any.

false

object

 

v1.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Name Description Required Schema Default

fieldRef

Selects a field of the pod; only name and namespace are supported.

false

v1.ObjectFieldSelector

 

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

 

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

 

secretKeyRef

Selects a key of a secret in the pod’s namespace

false

v1.SecretKeySelector

 

v1.Scale

Scale represents a scaling request for a resource.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object metadata; More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata.

false

v1.ObjectMeta

 

spec

defines the behavior of the scale. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status.

false

v1.ScaleSpec

 

status

current status of the scale. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status. Read-only.

false

v1.ScaleStatus

 

v1.LoadBalancerIngress

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

Name Description Required Schema Default

ip

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

false

string

 

hostname

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

false

string

 

v1.KeyToPath

Maps a string key to a path within a volume.

Name Description Required Schema Default

key

The key to project.

true

string

 

path

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

true

string

 

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.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines the behavior of a service.http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.ServiceSpec

 

status

Most recently observed status of the service. Populated by the system. Read-only. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.ServiceStatus

 

v1.VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

Name Description Required Schema Default

volumePath

Path that identifies vSphere volume vmdk

true

string

 

fsType

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.

false

string

 

v1.ServiceAccountList

ServiceAccountList is a list of ServiceAccount objects

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

List of ServiceAccounts. More info:http://releases.k8s.io/release-1.3/docs/design/service_accounts.md#service-accounts

true

v1.ServiceAccountarray

 

v1.LimitRangeList

LimitRangeList is a list of LimitRange items.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

Items is a list of LimitRange objects. More info:http://releases.k8s.io/release-1.3/docs/design/admission_control_limit_range.md

true

v1.LimitRange array

 

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

subsets

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.

true

v1.EndpointSubsetarray

 

v1.DeleteOptions

DeleteOptions may be provided when deleting an API object

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

gracePeriodSeconds

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.

false

integer (int64)

 

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

 

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

false

v1.Volume

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

Name Description Required Schema Default

name

Volume’s name. Must be a DNS_LABEL and unique within the pod. More info:http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

true

string

 

hostPath

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://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

 

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#emptydir

false

v1.EmptyDirVolumeSource

 

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

 

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

 

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

 

secret

Secret represents a secret that should populate this volume. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#secrets

false

v1.SecretVolumeSource

 

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

false

v1.NFSVolumeSource

 

iscsi

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/release-1.3/examples/iscsi/README.md

false

v1.ISCSIVolumeSource

 

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md

false

v1.GlusterfsVolumeSource

 

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

 

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info:http://releases.k8s.io/release-1.3/examples/rbd/README.md

false

v1.RBDVolumeSource

 

flexVolume

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

false

v1.FlexVolumeSource

 

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info:http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

 

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

 

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

 

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

 

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

 

azureFile

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

false

v1.AzureFileVolumeSource

 

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

 

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

 

v1.ResourceFieldSelector

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

Name Description Required Schema Default

containerName

Container name: required for volumes, optional for env vars

false

string

 

resource

Required: resource to select

true

string

 

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

 

v1.Probe

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

Name Description Required Schema Default

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

 

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

 

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

 

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

 

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

 

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

 

successThreshold

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.

false

integer (int32)

 

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

 

unversioned.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

 

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResourcearray

 

v1.SecretKeySelector

SecretKeySelector selects a key of a Secret.

Name Description Required Schema Default

name

Name of the referent. More info:http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

false

string

 

key

The key of the secret to select from. Must be a valid secret key.

true

string

 

v1.ReplicationController

ReplicationController represents the configuration of a replication controller.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

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/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines the specification of the desired behavior of the replication controller. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.ReplicationControllerSpec

 

status

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/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.ReplicationControllerStatus

 

v1.Capability

unversioned.APIResource

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

Name Description Required Schema Default

name

name is the name of the resource.

true

string

 

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resourcefoo)

true

string

 

v1.PodStatus

PodStatus represents information about the status of a pod. Status may trail the actual state of a system.

Name Description Required Schema Default

phase

Current condition of the pod. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#pod-phase

false

string

 

conditions

Current service state of pod. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#pod-conditions

false

v1.PodCondition array

 

message

A human readable message indicating details about why the pod is in this condition.

false

string

 

reason

A brief CamelCase message indicating details about why the pod is in this state. e.g.OutOfDisk

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

The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#container-statuses

false

v1.ContainerStatusarray

 

v1.LimitRange

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines the limits enforced. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.LimitRangeSpec

 

v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name Description Required Schema Default

path

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

true

string

 

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

 

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

 

v1.PodSpec

PodSpec is a description of a pod.

Name Description Required Schema Default

volumes

List of volumes that can be mounted by containers belonging to the pod. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md

false

v1.Volume array

 

containers

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://releases.k8s.io/release-1.3/docs/user-guide/containers.md

true

v1.Container array

 

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info:http://releases.k8s.io/release-1.3/docs/user-guide/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 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.

false

integer (int64)

 

activeDeadlineSeconds

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.

false

integer (int64)

 

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

 

nodeSelector

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://releases.k8s.io/release-1.3/docs/user-guide/node-selection/README.md

false

object

 

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info:http://releases.k8s.io/release-1.3/docs/design/service_accounts.md

false

string

 

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

 

nodeName

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.

false

string

 

hostNetwork

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.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

 

imagePullSecrets

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://releases.k8s.io/release-1.3/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReferencearray

 

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

 

subdomain

If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.

false

string

 

v1.ContainerPort

ContainerPort represents a network port in a single container.

Name Description Required Schema Default

name

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.

false

string

 

hostPort

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.

false

integer (int32)

 

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

 

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

 

hostIP

What host IP to bind the external port to.

false

string

 

v1.ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

spec

Spec defines the desired quota.http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaSpec

 

status

Status defines the actual enforced quota and its current usage.http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaStatus

 

v1.EventList

EventList is a list of events.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

List of events

true

v1.Event array

 

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.

Name Description Required Schema Default

postStart

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://releases.k8s.io/release-1.3/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

 

preStop

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://releases.k8s.io/release-1.3/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

 

v1.ReplicationControllerSpec

ReplicationControllerSpec is the specification of a replication controller.

Name Description Required Schema Default

replicas

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info:http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md#what-is-a-replication-controller

false

integer (int32)

 

selector

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://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

object

 

template

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://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md#pod-template

false

v1.PodTemplateSpec

 

v1.Handler

Handler defines a specific action that should be taken

Name Description Required Schema Default

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

 

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

 

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

 

v1.NodeStatus

NodeStatus is information about the current status of a node.

Name Description Required Schema Default

capacity

Capacity represents the total resources of a node. More info:http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#capacity for more details.

false

object

 

allocatable

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

false

object

 

phase

NodePhase is the recently observed lifecycle phase of the node. More info:http://releases.k8s.io/release-1.3/docs/admin/node.md#node-phase

false

string

 

conditions

Conditions is an array of current observed node conditions. More info:http://releases.k8s.io/release-1.3/docs/admin/node.md#node-condition

false

v1.NodeCondition array

 

addresses

List of addresses reachable to the node. Queried from cloud provider, if available. More info:http://releases.k8s.io/release-1.3/docs/admin/node.md#node-addresses

false

v1.NodeAddress array

 

daemonEndpoints

Endpoints of daemons running on the Node.

false

v1.NodeDaemonEndpoints

 

nodeInfo

Set of ids/uuids to uniquely identify the node. More info:http://releases.k8s.io/release-1.3/docs/admin/node.md#node-info

false

v1.NodeSystemInfo

 

images

List of container images on this node

false

v1.ContainerImage array

 

volumesInUse

List of attachable volumes in use (mounted) by the node.

false

v1.UniqueVolumeNamearray

 

volumesAttached

List of volumes that are attached to the node.

false

v1.AttachedVolume array

 

v1.GlusterfsVolumeSource

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

Name Description Required Schema Default

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info:http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

true

string

 

path

Path is the Glusterfs volume path. More info:http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

true

string

 

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info:http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

false

boolean

false

v1.AttachedVolume

AttachedVolume describes a volume attached to a node

Name Description Required Schema Default

name

Name of the attached volume

true

string

 

devicePath

DevicePath represents the device path where the volume should be avilable

true

string

 

v1.EventSource

EventSource contains information for an event.

Name Description Required Schema Default

component

Component from which the event is generated.

false

string

 

host

Host name on which the event is generated.

false

string

 

v1.PodCondition

PodCondition contains details for the current condition of this pod.

Name Description Required Schema Default

type

Type is the type of the condition. Currently only Ready. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#pod-conditions

true

string

 

status

Status is the status of the condition. Can be True, False, Unknown. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#pod-conditions

true

string

 

lastProbeTime

Last time we probed the condition.

false

string

 

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string

 

reason

Unique, one-word, CamelCase reason for the condition’s last transition.

false

string

 

message

Human-readable message indicating details about last transition.

false

string

 

v1.RBDVolumeSource

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

Name Description Required Schema Default

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

true

string array

 

image

The rados image name. More info:http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

true

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:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#rbd

false

string

 

pool

The rados pool name. Default is rbd. More info:http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it.

false

string

 

user

The rados user name. Default is admin. More info:http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

false

string

 

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info:http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

false

string

 

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info:http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

 

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info:http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

false

boolean

false

v1.PodTemplate

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

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard object’s metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

 

template

Template defines the pods that will be created from this pod template.http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.PodTemplateSpec

 

v1.ServiceStatus

ServiceStatus represents the current status of a service.

Name Description Required Schema Default

loadBalancer

LoadBalancer contains the current status of the load-balancer, if one is present.

false

v1.LoadBalancerStatus

 

v1.NFSVolumeSource

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

Name Description Required Schema Default

server

Server is the hostname or IP address of the NFS server. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

true

string

 

path

Path that is exported by the NFS server. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

true

string

 

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info:http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

false

boolean

false

v1.HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Name Description Required Schema Default

name

The header field name

true

string

 

value

The header field value

true

string

 

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.

Name Description Required Schema Default

targetWWNs

Required: FC target world wide names (WWNs)

true

string array

 

lun

Required: FC target lun number

true

integer (int32)

 

fsType

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.

false

string

 

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

v1.EndpointPort

EndpointPort is a tuple that describes a single port.

Name Description Required Schema Default

name

The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.

false

string

 

port

The port number of the endpoint.

true

integer (int32)

 

protocol

The IP protocol for this port. Must be UDP or TCP. Default is TCP.

false

string

 

v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket

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

 

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.

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

 

group

The group attribute of the resource associated with the status StatusReason.

false

string

 

kind

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/release-1.3/docs/devel/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

unversioned.StatusCausearray

 

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

 

v1.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Name Description Required Schema Default

path

Path to access on the HTTP server.

false

string

 

port

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.

true

string

 

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

 

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

 

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

 

v1.LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.

Name Description Required Schema Default

ingress

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

false

v1.LoadBalancerIngressarray

 

v1.SecretList

SecretList is a list of Secret.

Name Description Required Schema Default

kind

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/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

 

apiVersion

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/release-1.3/docs/devel/api-conventions.md#resources

false

string

 

metadata

Standard list metadata. More info:http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

 

items

Items is a list of secret objects. More info:http://releases.k8s.io/release-1.3/docs/user-guide/secrets.md

true

v1.Secret array

 

v1.Container

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

Name Description Required Schema Default

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

 

image

Docker image name. More info:http://releases.k8s.io/release-1.3/docs/user-guide/images.md

false

string

 

command

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://releases.k8s.io/release-1.3/docs/user-guide/containers.md#containers-and-commands

false

string array

 

args

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://releases.k8s.io/release-1.3/docs/user-guide/containers.md#containers-and-commands

false

string array

 

workingDir

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.

false

string

 

ports

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.

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. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

 

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

 

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

 

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info:http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

 

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

 

terminationMessagePath

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.

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. More info:http://releases.k8s.io/release-1.3/docs/user-guide/images.md#updating-images

false

string

 

你可能感兴趣的:(k8s api object)