Top Level API Objects
Definitions
v1beta1.DeploymentStatus
DeploymentStatus is the most recently observed status of the Deployment.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
observedGeneration |
The generation observed by the deployment controller. |
false |
integer (int64) |
|
replicas |
Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
false |
integer (int32) |
|
updatedReplicas |
Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
false |
integer (int32) |
|
availableReplicas |
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
false |
integer (int32) |
|
unavailableReplicas |
Total number of unavailable pods targeted by this deployment. |
false |
integer (int32) |
|
conditions |
Represents the latest available observations of a deployment’s current state. |
false |
v1beta1.DaemonSetStatus
DaemonSetStatus represents the current status of a daemon set.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
currentNumberScheduled |
CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md |
true |
integer (int32) |
|
numberMisscheduled |
NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md |
true |
integer (int32) |
|
desiredNumberScheduled |
DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md |
true |
integer (int32) |
|
numberReady |
NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. |
true |
integer (int32) |
v1beta1.Job
Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
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 |
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.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.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 |
v1beta1.IngressSpec
IngressSpec describes the Ingress the user wishes to exist.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
backend |
A default backend capable of servicing requests that don’t match any rule. At least one of backend or rules must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. |
false |
||
tls |
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
false |
v1beta1.IngressTLS array |
|
rules |
A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. |
false |
v1beta1.IngressRule array |
v1beta1.IngressBackend
IngressBackend describes all endpoints for a given service and port.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
serviceName |
Specifies the name of the referenced service. |
true |
string |
|
servicePort |
Specifies the port of the referenced service. |
true |
string |
v1beta1.ReplicaSetList
ReplicaSetList is a collection of ReplicaSets.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of ReplicaSets. More info: http://kubernetes.io/docs/user-guide/replication-controller |
true |
v1beta1.ReplicaSet array |
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/HEAD/examples/volumes/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/HEAD/examples/volumes/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/HEAD/examples/volumes/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/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
false |
||
readOnly |
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
false |
boolean |
false |
v1beta1.IngressStatus
IngressStatus describe the current state of the Ingress.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
loadBalancer |
LoadBalancer contains the current status of the load-balancer. |
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.DownwardAPIVolumeFile array |
|
defaultMode |
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
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. |
false |
string |
v1beta1.ReplicaSetCondition
ReplicaSetCondition describes the state of a replica set at a certain point.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of replica set condition. |
true |
string |
|
status |
Status of the condition, one of True, False, Unknown. |
true |
string |
|
lastTransitionTime |
The last time the condition transitioned from one status to another. |
false |
string (date-time) |
|
reason |
The reason for the condition’s last transition. |
false |
string |
|
message |
A human readable message indicating details about the transition. |
false |
string |
v1beta1.NetworkPolicyList
Network Policy List is a list of NetworkPolicy 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
Items is a list of schema objects. |
true |
v1beta1.NetworkPolicy array |
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://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
integer (int32) |
|
readOnly |
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
boolean |
false |
v1beta1.RollingUpdateDeployment
Spec to control the desired behavior of rolling update.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
maxUnavailable |
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |
false |
string |
|
maxSurge |
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods. |
false |
string |
v1beta1.HTTPIngressRuleValue
HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
paths |
A collection of paths that map requests to backends. |
true |
v1beta1.HTTPIngressPath array |
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://kubernetes.io/docs/user-guide/identifiers#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 |
|
defaultMode |
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
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 |
v1beta1.JobStatus
JobStatus represents the current state of a Job.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
conditions |
Conditions represent the latest available observations of an object’s current state. More info: http://kubernetes.io/docs/user-guide/jobs |
false |
v1beta1.JobCondition array |
|
startTime |
StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. |
false |
string (date-time) |
|
completionTime |
CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. |
false |
string (date-time) |
|
active |
Active is the number of actively running pods. |
false |
integer (int32) |
|
succeeded |
Succeeded is the number of pods which reached Phase Succeeded. |
false |
integer (int32) |
|
failed |
Failed is the number of pods which reached Phase Failed. |
false |
integer (int32) |
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.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://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
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://kubernetes.io/docs/user-guide/identifiers#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. |
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. |
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. |
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. |
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. |
false |
string (date-time) |
|
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 is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. |
false |
string (date-time) |
|
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://kubernetes.io/docs/user-guide/labels |
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://kubernetes.io/docs/user-guide/annotations |
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.OwnerReference array |
|
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 |
|
clusterName |
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. |
false |
string |
v1beta1.ReplicaSetSpec
ReplicaSetSpec is the specification of a ReplicaSet.
| 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://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller |
false |
integer (int32) |
|
minReadySeconds |
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) |
false |
integer (int32) |
|
selector |
Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
false |
||
template |
Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template |
false |
v1beta1.DaemonSetSpec
DaemonSetSpec is the specification of a daemon set.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
selector |
Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
false |
||
template |
Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template |
true |
v1beta1.Deployment
Deployment enables declarative updates for Pods and ReplicaSets.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object metadata. |
false |
||
spec |
Specification of the desired behavior of the Deployment. |
false |
||
status |
Most recently observed status of the Deployment. |
false |
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 |
types.UID
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://kubernetes.io/docs/user-guide/volumes#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://kubernetes.io/docs/user-guide/volumes#emptydir |
false |
string |
v1beta1.IngressList
IngressList is a collection of Ingress.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
Items is the list of Ingress. |
true |
v1beta1.Ingress array |
v1beta1.ScaleSpec
describes the attributes of a scale subresource
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
replicas |
desired number of instances for the scaled object. |
false |
integer (int32) |
unversioned.Patch
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
v1.FlockerVolumeSource
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
datasetName |
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
false |
string |
|
datasetUUID |
UUID of the dataset. This is unique identifier of a Flocker dataset |
false |
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://kubernetes.io/docs/user-guide/persistent-volumes#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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
false |
string |
v1beta1.HorizontalPodAutoscaler
configuration of a horizontal pod autoscaler.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. |
false |
||
status |
current information about the autoscaler. |
false |
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 |
v1beta1.RollbackConfig
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
revision |
The revision to rollback to. If set to 0, rollbck to the last revision. |
false |
integer (int64) |
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://kubernetes.io/docs/user-guide/volumes#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 |
|
defaultMode |
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
v1.EnvVarSource
EnvVarSource represents a source for the value of an EnvVar.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
fieldRef |
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP. |
false |
||
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 |
||
configMapKeyRef |
Selects a key of a ConfigMap. |
false |
||
secretKeyRef |
Selects a key of a secret in the pod’s namespace |
false |
v1.FlexVolumeSource
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
| 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 |
||
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 |
v1beta1.JobCondition
JobCondition describes current state of a job.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of job condition, Complete or Failed. |
true |
string |
|
status |
Status of the condition, one of True, False, Unknown. |
true |
string |
|
lastProbeTime |
Last time the condition was checked. |
false |
string (date-time) |
|
lastTransitionTime |
Last time the condition transit from one status to another. |
false |
string (date-time) |
|
reason |
(brief) reason for the condition’s last transition. |
false |
string |
|
message |
Human readable message indicating details about last transition. |
false |
string |
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 |
v1beta1.APIVersion
An APIVersion represents a single concrete version of an object model.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of this version (e.g. v1). |
false |
string |
v1.AzureDiskVolumeSource
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
diskName |
The Name of the data disk in the blob storage |
true |
string |
|
diskURI |
The URI the data disk in the blob storage |
true |
string |
|
cachingMode |
Host Caching mode: None, Read Only, Read Write. |
false |
||
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 |
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
false |
boolean |
false |
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 |
|
mode |
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
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.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/HEAD/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/HEAD/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 |
||
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://kubernetes.io/docs/user-guide/identifiers#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://kubernetes.io/docs/user-guide/volumes#hostpath |
false |
||
emptyDir |
EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |
false |
||
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://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
||
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://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
false |
||
gitRepo |
GitRepo represents a git repository at a particular revision. |
false |
||
secret |
Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets |
false |
||
nfs |
NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
false |
||
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/HEAD/examples/volumes/iscsi/README.md |
false |
||
glusterfs |
Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md |
false |
||
persistentVolumeClaim |
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims |
false |
||
rbd |
RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md |
false |
||
flexVolume |
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future. |
false |
||
cinder |
Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
||
cephfs |
CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
false |
||
flocker |
Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running |
false |
||
downwardAPI |
DownwardAPI represents downward API about the pod that should populate this volume |
false |
||
fc |
FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
false |
||
azureFile |
AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
false |
||
configMap |
ConfigMap represents a configMap that should populate this volume |
false |
||
vsphereVolume |
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
false |
||
quobyte |
Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
false |
||
azureDisk |
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
false |
||
photonPersistentDisk |
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
false |
v1beta1.DaemonSetList
DaemonSetList is a collection of daemon sets.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
Items is a list of daemon sets. |
true |
v1beta1.DaemonSet array |
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 |
||
httpGet |
HTTPGet specifies the http request to perform. |
false |
||
tcpSocket |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
false |
||
initialDelaySeconds |
Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes |
false |
integer (int32) |
|
timeoutSeconds |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes |
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) |
v1beta1.DeploymentSpec
DeploymentSpec is the specification of the desired behavior of the Deployment.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
replicas |
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
false |
integer (int32) |
|
selector |
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. |
false |
||
template |
Template describes the pods that will be created. |
true |
||
strategy |
The deployment strategy to use to replace existing pods with new ones. |
false |
||
minReadySeconds |
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) |
false |
integer (int32) |
|
revisionHistoryLimit |
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. |
false |
integer (int32) |
|
paused |
Indicates that the deployment is paused and will not be processed by the deployment controller. |
false |
boolean |
false |
rollbackTo |
The config this deployment is rolling back to. Will be cleared after rollback is done. |
false |
||
progressDeadlineSeconds |
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. This is not set by default. |
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/HEAD/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/HEAD/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.APIResource array |
v1.SecretKeySelector
SecretKeySelector selects a key of a Secret.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
key |
The key of the secret to select from. Must be a valid secret key. |
true |
string |
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 resource foo) |
true |
string |
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 |
||
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 |
||
mode |
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
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.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://kubernetes.io/docs/user-guide/volumes |
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://kubernetes.io/docs/user-guide/containers |
true |
v1.Container array |
|
restartPolicy |
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy |
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://kubernetes.io/docs/user-guide/node-selection |
false |
object |
|
serviceAccountName |
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md |
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 |
||
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://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod |
false |
v1.LocalObjectReference array |
|
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 "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
false |
string |
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://kubernetes.io/docs/user-guide/container-environment#hook-details |
false |
||
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://kubernetes.io/docs/user-guide/container-environment#hook-details |
false |
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/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
true |
string |
|
path |
Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/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/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
false |
boolean |
false |
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 |
||
httpGet |
HTTPGet specifies the http request to perform. |
false |
||
tcpSocket |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
false |
v1beta1.IngressTLS
IngressTLS describes the transport layer security associated with an Ingress.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
hosts |
Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. |
false |
string array |
|
secretName |
SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. |
false |
string |
v1beta1.SubresourceReference
SubresourceReference contains enough information to let you inspect or modify the referred subresource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
name |
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
apiVersion |
API version of the referent |
false |
string |
|
subresource |
Subresource name of the referent |
false |
string |
v1beta1.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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata. |
false |
||
spec |
defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. |
false |
||
status |
current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only. |
false |
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/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
true |
string array |
|
image |
The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/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://kubernetes.io/docs/user-guide/volumes#rbd |
false |
string |
|
pool |
The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it. |
false |
string |
|
user |
The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/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/HEAD/examples/volumes/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/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
false |
||
readOnly |
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
false |
boolean |
false |
v1.PhotonPersistentDiskVolumeSource
Represents a Photon Controller persistent disk resource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
pdID |
ID that identifies Photon Controller persistent disk |
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 |
v1beta1.NetworkPolicy
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Specification of the desired behavior for this NetworkPolicy. |
false |
versioned.Event
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
true |
string |
||
object |
true |
string |
v1beta1.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. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
false |
object |
|
targetSelector |
label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
false |
string |
v1beta1.NetworkPolicySpec
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
podSelector |
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. |
true |
||
ingress |
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list. |
false |
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://kubernetes.io/docs/user-guide/volumes#nfs |
true |
string |
|
path |
Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
true |
string |
|
readOnly |
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
false |
boolean |
false |
v1beta1.DeploymentList
DeploymentList is a list of Deployments.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. |
false |
||
items |
Items is the list of Deployments. |
true |
v1beta1.Deployment array |
v1beta1.DeploymentRollback
DeploymentRollback stores the information required to rollback a deployment.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
name |
Required: This must match the Name of a deployment. |
true |
string |
|
updatedAnnotations |
The annotations to be updated to a deployment |
false |
object |
|
rollbackTo |
The config of this deployment rollback. |
true |
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 |
v1beta1.HorizontalPodAutoscalerStatus
current status of a horizontal pod autoscaler
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
observedGeneration |
most recent generation observed by this autoscaler. |
false |
integer (int64) |
|
lastScaleTime |
last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed. |
false |
string (date-time) |
|
currentReplicas |
current number of replicas of pods managed by this autoscaler. |
true |
integer (int32) |
|
desiredReplicas |
desired number of replicas of pods managed by this autoscaler. |
true |
integer (int32) |
|
currentCPUUtilizationPercentage |
current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU. |
false |
integer (int32) |
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 worldwide 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 |
v1beta1.ThirdPartyResource
A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object metadata |
false |
||
description |
Description is the description of this object. |
false |
string |
|
versions |
Versions are versions for this third party object |
false |
v1beta1.APIVersion array |
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 |
v1beta1.DeploymentStrategy
DeploymentStrategy describes how to replace existing pods with new ones.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
false |
string |
|
rollingUpdate |
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. |
false |
v1beta1.IngressRule
IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
host |
Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the |
false |
string |
|
http |
false |
v1beta1.JobList
JobList is a collection of jobs. DEPRECATED: extensions/v1beta1.JobList is deprecated, use batch/v1.JobList instead.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
Items is the list of Job. |
true |
v1beta1.Job array |
v1beta1.NetworkPolicyPeer
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
podSelector |
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace. |
false |
||
namespaceSelector |
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces. |
false |
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/HEAD/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.StatusCause array |
|
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.LoadBalancerIngress array |
v1beta1.CPUTargetUtilization
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
targetPercentage |
fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use. |
true |
integer (int32) |
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://kubernetes.io/docs/user-guide/images |
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://kubernetes.io/docs/user-guide/containers#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://kubernetes.io/docs/user-guide/containers#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://kubernetes.io/docs/user-guide/persistent-volumes#resources |
false |
||
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://kubernetes.io/docs/user-guide/pod-states#container-probes |
false |
||
readinessProbe |
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes |
false |
||
lifecycle |
Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
false |
||
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://kubernetes.io/docs/user-guide/images#updating-images |
false |
string |
|
securityContext |
Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md |
false |
||
stdin |
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. |
false |
boolean |
false |
stdinOnce |
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
false |
boolean |
false |
tty |
Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false. |
false |
boolean |
false |
v1.PodSecurityContext
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
seLinuxOptions |
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
false |
||
runAsUser |
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. |
false |
integer (int64) |
|
runAsNonRoot |
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. |
false |
boolean |
false |
supplementalGroups |
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. |
false |
integer (int32) array |
|
fsGroup |
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: |
false |
integer (int64) |
v1beta1.NetworkPolicyIngressRule
This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ports |
List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. |
false |
||
from |
List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list. |
false |
v1.OwnerReference
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
apiVersion |
API version of the referent. |
true |
string |
|
kind |
Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
true |
string |
|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
true |
string |
|
uid |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
true |
string |
|
controller |
If true, this reference points to the managing controller. |
false |
boolean |
false |
v1beta1.ReplicaSetStatus
ReplicaSetStatus represents the current status of a ReplicaSet.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
replicas |
Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller |
true |
integer (int32) |
|
fullyLabeledReplicas |
The number of pods that have labels matching the labels of the pod template of the replicaset. |
false |
integer (int32) |
|
readyReplicas |
The number of ready replicas for this replica set. |
false |
integer (int32) |
|
availableReplicas |
The number of available replicas (ready for at least minReadySeconds) for this replica set. |
false |
integer (int32) |
|
observedGeneration |
ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
false |
integer (int64) |
|
conditions |
Represents the latest available observations of a replica set’s current state. |
false |
v1beta1.ReplicaSet
ReplicaSet represents the configuration of a ReplicaSet.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the specification of the desired behavior of the ReplicaSet. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.HostPathVolumeSource
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
path |
Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath |
true |
string |
v1beta1.DaemonSet
DaemonSet represents the configuration of a daemon set.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.CinderVolumeSource
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
volumeID |
volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
true |
string |
|
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
string |
|
readOnly |
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
boolean |
false |
v1.SecurityContext
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
capabilities |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
||
privileged |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
boolean |
false |
seLinuxOptions |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
||
runAsUser |
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. |
false |
integer (int64) |
|
runAsNonRoot |
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. |
false |
boolean |
false |
readOnlyRootFilesystem |
Whether this container has a read-only root filesystem. Default is false. |
false |
boolean |
false |
v1.Protocol
v1.AWSElasticBlockStoreVolumeSource
Represents a Persistent Disk resource in AWS.
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
volumeID |
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
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://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
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). |
false |
integer (int32) |
|
readOnly |
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
false |
boolean |
false |
v1beta1.HorizontalPodAutoscalerSpec
specification of a horizontal pod autoscaler.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
scaleRef |
reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec. |
true |
||
minReplicas |
lower limit for the number of pods that can be set by the autoscaler, default 1. |
false |
integer (int32) |
|
maxReplicas |
upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. |
true |
integer (int32) |
|
cpuUtilization |
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources. |
false |
v1.QuobyteVolumeSource
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
registry |
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
true |
string |
|
volume |
Volume is a string that references an already created Quobyte volume by name. |
true |
string |
|
readOnly |
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
false |
boolean |
false |
user |
User to map volume access to Defaults to serivceaccount user |
false |
string |
|
group |
Group to map volume access to Default is no group |
false |
string |
v1.EnvVar
EnvVar represents an environment variable present in a Container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the environment variable. Must be a C_IDENTIFIER. |
true |
string |
|
value |
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
false |
string |
|
valueFrom |
Source for the environment variable’s value. Cannot be used if value is not empty. |
false |
v1.ResourceRequirements
ResourceRequirements describes the compute resource requirements.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
limits |
Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/ |
false |
object |
|
requests |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/ |
false |
object |
v1.PodTemplateSpec
PodTemplateSpec describes the data a pod should have when created from a template
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1beta1.NetworkPolicyPort
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
protocol |
Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP. |
false |
||
port |
If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. |
false |
string |
v1beta1.DeploymentCondition
DeploymentCondition describes the state of a deployment at a certain point.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of deployment condition. |
true |
string |
|
status |
Status of the condition, one of True, False, Unknown. |
true |
string |
|
lastUpdateTime |
The last time this condition was updated. |
false |
string (date-time) |
|
lastTransitionTime |
Last time the condition transitioned from one status to another. |
false |
string (date-time) |
|
reason |
The reason for the condition’s last transition. |
false |
string |
|
message |
A human readable message indicating details about the transition. |
false |
string |
v1beta1.JobSpec
JobSpec describes how the job execution will look like.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
parallelism |
Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs |
false |
integer (int32) |
|
completions |
Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs |
false |
integer (int32) |
|
activeDeadlineSeconds |
Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer |
false |
integer (int64) |
|
selector |
Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
false |
||
autoSelector |
AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md |
false |
boolean |
false |
template |
Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs |
true |
unversioned.LabelSelectorRequirement
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
key |
key is the label key that the selector applies to. |
true |
string |
|
operator |
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist. |
true |
string |
|
values |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
string array |
unversioned.Status
Status is a return value for calls that don’t return other 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
status |
Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
string |
|
message |
A human-readable description of the status of this operation. |
false |
string |
|
reason |
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. |
false |
string |
|
details |
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
false |
||
code |
Suggested HTTP return code for this status, 0 if not set. |
false |
integer (int32) |
v1beta1.HorizontalPodAutoscalerList
list of horizontal pod autoscaler 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. |
false |
||
items |
list of horizontal pod autoscaler objects. |
true |
v1.ConfigMapKeySelector
Selects a key from a ConfigMap.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
key |
The key to select. |
true |
string |
v1beta1.HTTPIngressPath
HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
path |
Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e. this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend. |
false |
string |
|
backend |
Backend defines the referenced service endpoint to which the traffic will be forwarded to. |
true |
v1beta1.Ingress
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec is the desired state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status is the current state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1beta1.ThirdPartyResourceList
ThirdPartyResourceList is a list of ThirdPartyResources.
| 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/HEAD/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/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. |
false |
||
items |
Items is the list of ThirdPartyResources. |
true |
v1.AzureDataDiskCachingMode
any
Represents an untyped JSON map - see the description of the field for more info about the structure of this object.