• Cloud Container Engine

cce
  1. Help Center
  2. Cloud Container Engine
  3. API Reference
  4. Common Parameters
  5. Common Response Parameters

Common Response Parameters

Table 1 Response parameters of v1.ReplicationController

Name

Type

Description

kind

String

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.

apiVersion

String

Versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 17

-

spec

Table 18

-

status

Table 19

-

Table 2 Response parameters of v1.ReplicationControllerList

Name

Type

Description

kind

String

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.

apiVersion

String

Versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 15

-

items

Table 16

List of replication controllers.

Table 3 Response parameters of v1.Pod

Name

Type

Description

kind

String

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.

apiVersion

String

Versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 17

-

spec

Table 28

-

status

Table 8

-

Table 4 Response parameters of v1.PodList

Name

Type

Description

kind

String

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.

apiVersion

String

Versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 15

-

items

Table 7

List of pods.

Table 5 Response parameters of v1.PodTemplate

Name

Type

Description

kind

String

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.

apiVersion

String

Versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 17

-

template

Table 27

-

Table 6 Response parameters of v1.PodTemplateList

Parameter

Type

Description

kind

String

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.

apiVersion

String

Versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 68

-

items

Table 2

List of pod templates.

Table 7 Data structure of the items field

Name

Type

Description

kind

String

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.

apiVersion

String

Versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 17

-

spec

Table 28

-

status

Table 8

-

Table 8 Data structure of the status field

Name

Type

Description

phase

String

Current condition of the pod.

conditions

Table 9

Current service state of the pod.

message

String

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

reason

String

A brief CamelCase message indicating details about why the pod is in this state. For example, 'OutOfDisk'.

hostIP

String

IP address of the host to which the pod is assigned. Empty if not yet scheduled.

podIP

String

IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.

startTime

String

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.

containerStatuses

Table 10

The list has one entry per container in the manifest. Each entry is currently the output of docker inspect.

Table 9 Data structure of the conditions field

Name

Type

Description

type

String

Type of the condition. Currently only Ready.

status

String

Status of the condition. Can be True, False, or Unknown.

lastProbeTime

String

Last time we probed the condition.

lastTransitionTime

String

Last time the condition transitioned from one status to another.

reason

String

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

message

String

Human-readable message indicating details about last transition.

Table 10 Data structure of the containerStatuses field

Name

Type

Description

name

String

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

state

Table 11

-

lastState

Table 11

-

ready

Boolean

A flag indicating whether the container has passed its readiness probe.

restartCount

Integer

The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. However, those containers are subject to garbage collection. This value will get capped at 5 by GC.

image

String

Image that the container is running.

imageID

String

ID of the container's image.

containerID

String

Container's ID in the format 'docker://'.

Table 11 Data structure of the state/lastState field

Name

Type

Description

waiting

Table 12

-

running

Table 13

-

terminated

Table 14

-

Table 12 Data structure of the waiting field

Name

Type

Description

reason

String

(Brief) reason the container is not yet running.

message

String

Message regarding why the container is not yet running.

Table 13 Data structure of the running field

Name

Type

Description

startedAt

String

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

Table 14 Data structure of the terminated field

Name

Type

Description

startedAt

Integer

Exit status from the last termination of the container.

signal

Integer

Signal from the last termination of the container.

reason

String

(Brief) reason from the last termination of the container.

message

String

Message regarding the last termination of the container.

startedAt

String

Time at which previous execution of the container started.

finishedAt

String

Time at which the container last terminated.

containerID

String

Container's ID in the format 'docker://'.

Table 15 Data structure of the metadata field

Parameter

Type

Description

selfLink

String

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

resourceVersion

String

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only.

Table 16 Data structure of the items field

Parameter

Type

Description

kind

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.

apiVersion

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

metadata

Table 17

-

spec

Table 18

-

status

Table 19

-

Table 17 Data structure of the metadata field

Parameter

Type

Description

name

String

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated.

clusterName

String

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

initializers

Table 20

(A newly added parameter in Kubernetes 1.7)

An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.

generateName

String

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified.

namespace

String

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated.

selfLink

String

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

uid

String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only.

resourceVersion

String

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients.

generation

Integer

A sequence number representing a specific generation of the desired state. Currently only implemented by replication controllers. Populated by the system. Read-only.

creationTimestamp

String

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.

deletionTimestamp

String

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.

deletionGracePeriodSeconds

Integer

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

labels

Map[string]string

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.

Annotations

Map[string]string

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.

ownerReferences

Table 26

(A newly added parameter in Kubernetes 1.3)

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.

finalizers

String array

(A newly added parameter in Kubernetes 1.3)

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.

Table 18 Data structure of the spec field

Parameter

Type

Description

replicas

Integer

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.

selector

object

Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template.

minReadySeconds

Integer

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

template

Table 27

-

Table 19 Data structure of the status field

Parameter

Type

Description

replicas

Integer

Replicas is the most recently observed number of replicas.

availableReplicas

Integer

(A newly added parameter in Kubernetes 1.7)

The number of available replicas (ready for at least minReadySeconds) for this replication controller.

readyReplicas

Integer

(A newly added parameter in Kubernetes 1.7)

The number of ready replicas for this replication controller.

fullyLabeledReplicas

Integer

(A newly added parameter in Kubernetes 1.7)

The number of pods that have labels matching the labels of the pod template of the replication controller.

conditions

Table 67

(A newly added parameter in Kubernetes 1.7)

Represents the latest available observations of a replication controller's current state.

observedGeneration

Integer

ObservedGeneration reflects the generation of the most recently observed replication controller.

Table 20 Data structure of the initializers field

Parameter

Type

Description

pending

Table 21

(A newly added parameter in Kubernetes 1.7)

Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

result

Table 22

(A newly added parameter in Kubernetes 1.7)

If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

Table 21 Data structure of the pending field

Parameter

Type

Description

name

String

(A newly added parameter in Kubernetes 1.7)

name of the process that is responsible for initializing this object.

Table 22 Data structure of the result field

Parameter

Type

Description

apiVersion

String

(A newly added parameter in Kubernetes 1.7)

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.

code

Integer

(A newly added parameter in Kubernetes 1.7)

Suggested HTTP return code for this status, 0 if not set.

details

Table 23

(A newly added parameter in Kubernetes 1.7)

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

kind

String

(A newly added parameter in Kubernetes 1.7)

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.

message

String

(A newly added parameter in Kubernetes 1.7)

A human-readable description of the status of this operation.

metadata

Table 24

(A newly added parameter in Kubernetes 1.7)

Standard list metadata.

reason

String

(A newly added parameter in Kubernetes 1.7)

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

status

String

(A newly added parameter in Kubernetes 1.7)

Status of the operation. One of: "Success" or "Failure".

Table 23 Data structure of the details field

Parameter

Type

Description

causes

Table 25

(A newly added parameter in Kubernetes 1.7)

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

group

String

(A newly added parameter in Kubernetes 1.7)

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

kind

String

(A newly added parameter in Kubernetes 1.7)

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind.

name

String

(A newly added parameter in Kubernetes 1.7)

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

retryAfterSeconds

Integer

(A newly added parameter in Kubernetes 1.7)

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

uid

String

(A newly added parameter in Kubernetes 1.7)

UID of the resource. (when there is a single resource which can be described).

Table 24 Data structure of the metadata field

Parameter

Type

Description

resourceVersion

String

(A newly added parameter in Kubernetes 1.7)

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.

selfLink

String

(A newly added parameter in Kubernetes 1.7)

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

Table 25 Data structure of the causes field

Parameter

Type

Description

field

String

(A newly added parameter in Kubernetes 1.7)

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

message

String

(A newly added parameter in Kubernetes 1.7)

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

reason

String

(A newly added parameter in Kubernetes 1.7)

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

Table 26 Data structure of the ownerReferences field

Parameter

Type

Description

apiVersion

String

(A newly added parameter in Kubernetes 1.3)

API version of the referent.

blockOwnerDeletion

Boolean

(A newly added parameter in Kubernetes 1.7)

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

kind

String

(A newly added parameter in Kubernetes 1.3)

Kind of the referent.

name

String

(A newly added parameter in Kubernetes 1.3)

Name of the referent.

uid

String

(A newly added parameter in Kubernetes 1.3)

UID of the referent.

controller

Boolean

(A newly added parameter in Kubernetes 1.3)

If true, this reference points to the managing controller.

Table 27 Data structure of the template field

Parameter

Type

Description

metadata

Table 17

-

spec

Table 28

-

Table 28 Data structure of the spec field

Parameter

Type

Description

volumes

Table 29

List of volumes that can be mounted by containers belonging to the pod.

containers

Table 30

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.

restartPolicy

String

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always.

terminationGracePeriodSeconds

Integer

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

activeDeadlineSeconds

Integer

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

dnsPolicy

String

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

serviceAccountName

String

ServiceAccountName is the name of the ServiceAccount to use to run this pod.

serviceAccount

String

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

nodeName

String

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

hostNetwork

Boolean

Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default: false.

hostPID

Boolean

Use the host's pid namespace. Optional.

Default: false.

hostIPC

Boolean

Use the host's ipc namespace. Optional.

Default: false.

securityContext

Table 31

-

imagePullSecrets

Table 32

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.

Table 29 Data structure of the volumes field

Parameter

Type

Description

name

String

Volume's name. Must be a DNS_LABEL and unique within the pod.

hostPath

Table 33

-

emptyDir

Table 34

-

gitRepo

Table 35

-

secret

Table 36

-

nfs

Table 37

-

iscsi

Table 38

-

glusterfs

Table 39

-

persistentVolumeClaim

Table 40

-

rbd

Table 41

-

cinder

Table 42

-

cephfs

Table 43

-

flocker

Table 44

-

downwardAPI

Table 45

-

fc

Table 46

-

vsphereVolume

Table 47

(A newly added parameter in Kubernetes 1.3)

hwsElasticVolumeService

Table 48

hwsElasticVolumeService represents a Disk resource that is attached to a kubelet's host machine and then exposed to the pod.

NOTICE:

EVSs are AZ-specific and cannot be used cross AZs. Different EVSs must be created for different AZs.

Table 30 Data structure of the containers field

Parameter

Type

Description

name

String

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

image

String

Docker image name.

command

Array[string]

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 $$, for example, $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.

args

Array[string]

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 $$, for example, $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.

workingDir

String

Container's working directory. Defaults to Docker's default. Defaults to image's default. Cannot be updated.

ports

Table49 Data structure of the ports field

List of ports to expose from the container. Cannot be updated.

env

Table50 Data structure of the env field

List of environment variables to set in the container. Cannot be updated.

resources

Table51 Data structure of the resources field

Resources represents the minimum resources the volume should have.

volumeMounts

Table52 Data structure of the volumeMounts field

Pod volumes to mount into the container's file system. Cannot be updated.

livenessProbe

Table53 Data structure of the livenessProbe field

-

readinessProbe

Table 53

-

lifecycle

Table 54

-

terminationMessagePath

String

Path at which the file to which the container's termination message will be written is mounted into the container's file system. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

imagePullPolicy

String

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if the latest tag is specified, or IfNotPresent otherwise. Cannot be updated.

securityContext

Table 55

-

stdin

Boolean

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

stdinOnce

Boolean

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

tty

Boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

Table 31 Data structure of the securityContext field

Parameter

Type

Description

seLinuxOptions

Table 56

-

runAsUser

Integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

runAsNonRoot

Boolean

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

supplementalGroups

Array[integer]

A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.

fsGroup

Integer

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw.

Table 32 Data structure of the imagePullSecrets field

Parameter

Type

Description

name

String

Name of the referent.

Table 33 Data structure of the hostPath field

Parameter

Type

Description

path

String

Path of the directory on the host.

Table 34 Data structure of the emptyDir field

Parameter

Type

Description

medium

String

What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory.

Table 35 Data structure of the gitRepo field

Parameter

Type

Description

repository

String

Repository URL

revision

String

Commit hash for the specified revision.

Table 36 Data structure of the secret field

Parameter

Type

Description

secretName

String

SecretName is the name of a secret in the pod's namespace.

Table 37 Data structure of the nfs field

Parameter

Type

Description

server

String

Server is the hostname or IP address of the NFS server.

path

String

Path that is exported by the NFS server.

readOnly

Boolean

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false.

Table 38 Data structure of the iscsi field

Parameter

Type

Description

targetPortal

String

iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

iqn

String

Target iSCSI Qualified Name.

lun

Integer

iSCSI target lun number.

fsType

String

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

readOnly

Boolean

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

Table 39 Data structure of the glusterfs field

Parameter

Type

Description

endpoints

String

EndpointsName is the endpoint name that details Glusterfs topology.

path

String

Path is the Glusterfs volume path.

readOnly

Boolean

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false.

Table 40 Data structure of the persistentVolumeClaim field

Parameter

Type

Description

claimName

String

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.

readOnly

Boolean

Will force the ReadOnly setting in VolumeMounts. Default false.

Table 41 Data structure of the rbd field

Parameter

Type

Description

monitors

Array[string]

A collection of Ceph monitors.

image

String

The rados image name.

fsType

String

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs".

pool

String

The rados pool name. Default is rbd.

user

String

The rados user name. Default is admin.

keyring

String

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring.

secretRef

Table 32

-

readOnly

Boolean

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

Table 42 Data structure of the cinder field

Parameter

Type

Description

volumeID

Array[string]

volume id used to identify the volume in cinder

fsType

String

Required: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Only ext3 and ext4 are allowed.

readOnly

Boolean

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

Table 43 Data structure of the cephfs field

Parameter

Type

Description

monitors

Array[string]

Required: Monitors is a collection of Ceph monitors

user

String

Optional: User is the rados user name.

Default: admin.

secretFile

String

SecretFile is the path to key ring for User.

Default: /etc/ceph/user.

secretRef

Table 32

-

readOnly

Boolean

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

Table 44 Data structure of the flocker field

Parameter

Type

Description

datasetName

String

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

Table 45 Data structure of the downwardAPI field

Parameter

Type

Description

items

Table 57

Items is a list of downward API volume file.

Table 46 Data structure of the fc field

Parameter

Type

Description

targetWWNs

Array[string]

Required: FC target world wide names (WWNs)

lun

Integer

Required: FC target lun number

fsType

String

Required: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs"

readOnly

Boolean

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

Table 47 Data structure of the vsphereVolume field

Name

Type

Description

volumePath

String

(A newly added parameter in Kubernetes 1.3)

Path that identifies vSphere volume vmdk.

fsType

String

(A newly added parameter in Kubernetes 1.3)

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.

Table 48 Data structure of the hwsElasticVolumeService field

Name

Type

Description

volumeID

Array[string]

volume id used to identify the volume in evs

fsType

String

Required: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Only ext3 and ext4 are allowed.

readOnly

Boolean

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

Table 49 Data structure of the ports field

Parameter

Type

Description

name

String

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

hostPort

Integer

Number of the 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.

containerPort

Integer

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

protocol

String

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

hostIP

String

What host IP to bind the external port to.

Table 50 Data structure of the env field

Parameter

Type

Description

name

String

Name of the environment variable. Must be a C_IDENTIFIER.

value

String

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

valueFrom

Table 58

-

Table 51 Data structure of the resources field

Parameter

Type

Description

limits

object

Limits describes the maximum amount of compute resources allowed.

requests

object

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value.

Table 52 Data structure of the volumeMounts field

Parameter

Type

Description

name

String

This must match the Name of a Volume.

readOnly

Boolean

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

mountPath

String

Path within the container at which the volume should be mounted.

subPath

String

(A newly added parameter in Kubernetes 1.3)

Path within the volume from which the container's volume should be mounted.

Defaults to "" (volume's root).

Table 53 Data structure of the livenessProbe field

Parameter

Type

Description

exec

Table 59

-

httpGet

Table 60

-

tcpSocket

Table 61

-

initialDelaySeconds

Integer

Number of seconds after the container has started before liveness probes are initiated.

timeoutSeconds

Integer

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.

periodSeconds

Integer

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

successThreshold

Integer

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

failureThreshold

Integer

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

Table 54 Data structure of the lifecycle field

Parameter

Type

Description

postStart

Table 62

-

preStop

Table 62

-

Table 55 Data structure of the securityContext field

Parameter

Type

Description

capabilities

Table 63

-

privileged

Boolean

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

seLinuxOptions

Table 56

-

runAsUser

Integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

runAsNonRoot

Boolean

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

Table 56 Data structure of the seLinuxOptions field

Parameter

Type

Description

user

String

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

role

String

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

type

String

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

level

String

Level is SELinux level label that applies to the container.

Table 57 Data structure of the items field

Parameter

Type

Description

path

String

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'.

fieldRef

Table 64

-

Table 58 Data structure of the valueFrom field

Parameter

Type

Description

fieldRef

Table 64

-

resourceFieldRef

Table 65

(A newly added parameter in Kubernetes 1.3)

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

Table 59 Data structure of the exec field

Parameter

Type

Description

command

Array[string]

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

Table 60 Data structure of the httpGet field

Parameter

Type

Description

path

String

Path to access on the HTTP server.

port

String

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.

host

String

Host name to connect to, defaults to the pod IP.

scheme

String

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

Table 61 Data structure of the tcpSocket field

Parameter

Type

Description

port

String

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.

Table 62 Data structure of the postStart/preStop field

Parameter

Type

Description

exec

Table 59

-

httpGet

Table 60

-

tcpSocket

Table 61

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

Table 63 Data structure of the capabilities field

Parameter

Type

Description

add

Table66 Data structure of the add field

Added capabilities

drop

Table 66

Removed capabilities

Table 64 Data structure of the fieldRef field

Parameter

Type

Description

apiVersion

String

Version of the schema the FieldPath is written in terms of, defaults to "v1"

fieldPath

String

Path of the field to select in the specified API version.

Table 65 Data structure of the resourceFieldRef field

Name

Type

Description

containerName

String

(A newly added parameter in Kubernetes 1.3)

Container name: required for volumes; optional for env vars.

resource

String

(A newly added parameter in Kubernetes 1.3)

Required: resource to select.

divisor

Resource.Quantity

(A newly added parameter in Kubernetes 1.3)

Specifies the output format of the exposed resources. Defaults to "1".

Table 66 Data structure of the add field

Parameter

Type

Description

name

String

name is the name of the resource.

namespaced

Boolean

namespaced indicates if a resource is namespaced or not.

Default: false.

kind

String

kind is the kind for the resource.

Table 67 Data structure of the ReplicationControllerCondition field

Name

Type

Description

lastTransitionTime

String

The last time the condition transitioned from one status to another.

message

String

A human readable message indicating details about the transition.

reason

String

The reason for the condition's last transition.

status

String

Status of the condition.

Options: True, False, Unknown.

type

String

Type of replication controller condition.

Table 68 Data structure of the metadata field

Name

Type

Description

resourceVersion

String

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only.

selfLink

String

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