{% capture tabspec %}servicesample
+JSON,json,service-sample.json,/docs/user-guide/services/service-sample.json
+YAML,yaml,service-sample.yaml,/docs/user-guide/services/service-sample.yaml{% endcapture %}
+{% include tabs.html %}
+
+In English, this would read: "Create a set of tabs with the alias `servicesample`,
+and have tabs visually labeled "JSON" and "YAML" that use `json` and `yaml` Rouge syntax highlighting, which display the contents of
+`service-sample.{extension}` on the page, and link to the file in GitHub at (full path)."
+
+Example file: [Pods: Multi-Container](/docs/user-guide/pods/multi-container/).
+
## Use a global variable
The `/_config.yml` file defines some useful variables you can use when editing docs.
diff --git a/_config.yml b/_config.yml
index 84a5524023..c3eaba8b58 100644
--- a/_config.yml
+++ b/_config.yml
@@ -14,11 +14,16 @@ lsi: false
defaults:
-
scope:
- path: "docs"
+ path: ""
values:
version: "v1.2"
- layout: docwithnav
- showedit: true
githubbranch: "release-1.2"
docsbranch: "master"
+ -
+ scope:
+ path: "docs"
+ values:
+ layout: docwithnav
+ showedit: true
+
permalink: pretty
diff --git a/_data/guides.yml b/_data/guides.yml
index 59f44d7123..502c7a8dad 100644
--- a/_data/guides.yml
+++ b/_data/guides.yml
@@ -132,6 +132,12 @@ toc:
path: /docs/getting-started-guides/scratch/
- title: Authenticating Across Clusters with kubeconfig
path: /docs/user-guide/kubeconfig-file/
+ - title: Replication Controller Operations
+ path: /docs/user-guide/replication-controller/operations/
+ - title: Resizing a Replication Controller
+ path: /docs/user-guide/resizing-a-replication-controller/
+ - title: Service Operations
+ path: /docs/user-guide/services/operations/
- title: Using Nodes, Pods, and Containers
section:
@@ -147,6 +153,10 @@ toc:
path: /docs/user-guide/getting-into-containers/
- title: The Lifecycle of a Pod
path: /docs/user-guide/pod-states/
+ - title: Creating Single-Container Pods
+ path: /docs/user-guide/pods/single-container/
+ - title: Creating Multi-Container Pods
+ path: /docs/user-guide/pods/multi-container/
- title: Pod Templates
path: /docs/user-guide/pod-templates/
- title: Assigning Pods to Nodes
@@ -166,6 +176,8 @@ toc:
section:
- title: Networking in Kubernetes
path: /docs/admin/networking/
+ - title: Creating an External Load Balancer
+ path: /docs/user-guide/load-balancer/
- title: Using DNS Pods and Services
path: /docs/admin/dns/
- title: Setting Up and Configuring DNS
@@ -224,6 +236,8 @@ toc:
path: /docs/user-guide/managing-deployments/
- title: Deploying Applications
path: /docs/user-guide/deploying-applications/
+ - title: Updating Applications with Rolling Updates
+ path: /docs/user-guide/rolling-updates/
- title: Launching, Exposing, and Killing Applications
path: /docs/user-guide/quick-start/
diff --git a/_data/reference.yml b/_data/reference.yml
index fa675d0a82..de1fe5fbea 100644
--- a/_data/reference.yml
+++ b/_data/reference.yml
@@ -32,6 +32,20 @@ toc:
- title: Extensions API Definitions
path: /docs/api-reference/extensions/v1beta1/definitions/
+- title: Autoscaling API
+ section:
+ - title: Autoscaling API Operations
+ path: /docs/api-reference/autoscaling/v1/operations/
+ - title: Autoscaling API Definitions
+ path: /docs/api-reference/autoscaling/v1/definitions/
+
+- title: Batch API
+ section:
+ - title: Batch API Operations
+ path: /docs/api-reference/batch/v1/operations/
+ - title: Batch API Definitions
+ path: /docs/api-reference/batch/v1/definitions/
+
- title: kubectl CLI
section:
- title: kubectl Overview
@@ -155,7 +169,7 @@ toc:
- title: kube-proxy CLI
path: /docs/admin/kube-proxy/
-- title: kub-scheduler CLI
+- title: kube-scheduler CLI
path: /docs/admin/kube-scheduler/
- title: kubelet CLI
diff --git a/_data/support.yml b/_data/support.yml
index 6b7daa8e3f..410e24e17c 100644
--- a/_data/support.yml
+++ b/_data/support.yml
@@ -6,6 +6,8 @@ toc:
- title: Troubleshooting
section:
+ - title: Debugging Pods and Replication Controllers
+ path: /docs/user-guide/debugging-pods-and-replication-controllers/
- title: Web Interface
path: /docs/user-guide/ui/
- title: Application Introspection and Debugging
diff --git a/_includes/head-header.html b/_includes/head-header.html
index 154466fe7d..b62c6d9bba 100644
--- a/_includes/head-header.html
+++ b/_includes/head-header.html
@@ -4,9 +4,11 @@
-
+
+
+
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 |
++ |
ObjectFieldSelector selects an APIVersioned field of an object.
+VolumeMount describes a mounting of a Volume within a container.
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. |
+name |
+This must match the Name of a Volume. |
true |
string |
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://releases.k8s.io/release-1.2/docs/user-guide/labels.md#label-selectors |
+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 |
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 |
-- |
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
server |
-Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs |
-true |
-string |
-- |
path |
-Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs |
-true |
-string |
-- |
readOnly |
-ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs |
-false |
-boolean |
-false |
-
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
-false |
-string |
-- |
metadata |
-Standard list metadata. |
-false |
-- | - |
items |
-Items is the list of Deployments. |
-true |
-v1beta1.Deployment array |
-- |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
-false |
-string |
-- |
metadata |
-Standard list metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-- | - |
items |
-List of ReplicaSets. More info: http://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md |
-true |
-v1beta1.ReplicaSet array |
-- |
DeploymentRollback stores the information required to rollback a deployment.
+ReplicaSetList is a collection of ReplicaSets.
name |
-Required: This must match the Name of a deployment. |
-true |
-string |
-- | |||
updatedAnnotations |
-The annotations to be updated to a deployment |
+metadata |
+Standard list metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
false |
-+ | ||
rollbackTo |
-The config of this deployment rollback. |
+items |
+List of ReplicaSets. More info: http://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md |
true |
-- | - |
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 |
-- |
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) |
-- |
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.ReplicaSet array |
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
targetWWNs |
-Required: FC target world wide names (WWNs) |
-true |
-string array |
-- |
lun |
-Required: FC target lun number |
-true |
-integer (int32) |
-- |
fsType |
-Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
-false |
-string |
-- |
readOnly |
-Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
-false |
-boolean |
-false |
-
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 |
-- | - |
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 |
-- |
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 |
-- | - |
JobList is a collection of jobs.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
kind |
-Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
-false |
-string |
-- |
metadata |
-Standard list metadata More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
-false |
-- | - |
items |
-Items is the list of Job. |
-true |
-v1beta1.Job array |
-- |
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
name |
-The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
-false |
-string |
-- |
group |
-The group attribute of the resource associated with the status StatusReason. |
-false |
-string |
-- |
kind |
-The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.2/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) |
-- |
HTTPGetAction describes an action based on HTTP Get requests.
+Adds and removes POSIX capabilities from running containers.
path |
-Path to access on the HTTP server. |
+add |
+Added capabilities |
false |
-string |
+v1.Capability array |
|
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. |
+drop |
+Removed capabilities |
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.Capability array |
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 |
-- |
LoadBalancerStatus represents the status of a load-balancer.
+ExecAction describes a "run in container" action.
ingress |
-Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
+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 |
-v1.LoadBalancerIngress array |
+string array |
+
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
+false |
+string |
++ |
generateName |
+GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. |
+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 |
++ |
deletionTimestamp |
+DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested. |
+false |
+string |
++ |
deletionGracePeriodSeconds |
+Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
+false |
+integer (int64) |
++ |
labels |
+Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.2/docs/user-guide/labels.md |
+false |
++ | + |
annotations |
+Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.2/docs/user-guide/annotations.md |
+false |
++ | + |
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://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md#what-is-a-replication-controller |
+false |
+integer (int32) |
++ |
selector |
+Selector is a label query over pods that should match the 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://releases.k8s.io/release-1.2/docs/user-guide/labels.md#label-selectors |
+false |
++ | + |
template |
+Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md#pod-template |
+false |
++ | + |
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://releases.k8s.io/release-1.2/docs/user-guide/labels.md#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://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md#pod-template |
+true |
++ | + |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/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 |
++ | + |
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 |
+
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
targetPortal |
+iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
+true |
+string |
++ |
iqn |
+Target iSCSI Qualified Name. |
+true |
+string |
++ |
lun |
+iSCSI target lun number. |
+true |
+integer (int32) |
++ |
iscsiInterface |
+Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport. |
+false |
+string |
++ |
fsType |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#iscsi |
+false |
+string |
++ |
readOnly |
+ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
+false |
+boolean |
+false |
+
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
medium |
+What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#emptydir |
+false |
+string |
++ |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object’s metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
+false |
++ | + |
items |
+Items is the list of Ingress. |
+true |
+v1beta1.Ingress array |
++ |
describes the attributes of a scale subresource
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
replicas |
+desired number of instances for the scaled object. |
+false |
+integer (int32) |
++ |
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
datasetName |
+Required: the volume name. This is going to be store on metadata → name on the payload for Flocker |
+true |
+string |
++ |
PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
claimName |
+ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
+true |
+string |
++ |
readOnly |
+Will force the ReadOnly setting in VolumeMounts. Default false. |
+false |
+boolean |
+false |
+
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
++ |
resourceVersion |
+String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
++ |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
+false |
++ | + |
spec |
+behaviour of autoscaler. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status. |
+false |
++ | + |
status |
+current information about the autoscaler. |
+false |
++ | + |
| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
revision |
+The revision to rollback to. If set to 0, rollbck to the last revision. |
+false |
+integer (int64) |
++ |
Adapts a Secret into a volume.
+The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
secretName |
+Name of the secret in the pod’s namespace to use. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#secrets |
+false |
+string |
++ |
EnvVarSource represents a source for the value of an EnvVar.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
fieldRef |
+Selects a field of the pod; only name and namespace are supported. |
+false |
++ | + |
configMapKeyRef |
+Selects a key of a ConfigMap. |
+false |
++ | + |
secretKeyRef |
+Selects a key of a secret in the pod’s namespace |
+false |
++ | + |
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
driver |
+Driver is the name of the driver to use for this volume. |
+true |
+string |
++ |
fsType |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
+false |
+string |
++ |
secretRef |
+Optional: SecretRef is reference to the authentication secret for User, default is empty. |
+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 |
++ | + |
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 |
++ |
lastTransitionTime |
+Last time the condition transit from one status to another. |
+false |
+string |
++ |
reason |
+(brief) reason for the condition’s last transition. |
+false |
+string |
++ |
message |
+Human readable message indicating details about last transition. |
+false |
+string |
++ |
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 |
++ |
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 |
++ |
DeleteOptions may be provided when deleting an API object
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/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. |
+true |
+integer (int64) |
++ |
Volume represents a named volume in a pod that may be accessed by any container in the pod.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
+true |
+string |
++ |
hostPath |
+HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#hostpath |
+false |
++ | + |
emptyDir |
+EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#secrets |
+false |
++ | + |
nfs |
+NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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/release-1.2/examples/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/release-1.2/examples/glusterfs/README.md |
+false |
++ | + |
persistentVolumeClaim |
+PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#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/release-1.2/examples/rbd/README.md |
+false |
++ | + |
flexVolume |
+FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future. |
+false |
++ | + |
cinder |
+Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.2/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 |
++ | + |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard list metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
+false |
++ | + |
items |
+Items is a list of daemon sets. |
+true |
+v1beta1.DaemonSet array |
++ |
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://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes |
+false |
+integer (int32) |
++ |
timeoutSeconds |
+Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes |
+false |
+integer (int32) |
++ |
periodSeconds |
+How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
+false |
+integer (int32) |
++ |
successThreshold |
+Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
+false |
+integer (int32) |
++ |
failureThreshold |
+Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
+false |
+integer (int32) |
++ |
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 |
++ | + |
SecretKeySelector selects a key of a Secret.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+Name of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
+false |
+string |
++ |
key |
+The key of the secret to select from. Must be a valid secret key. |
+true |
+string |
++ |
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. |
+true |
++ | + |
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 |
++ |
PodSpec is a description of a pod.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
volumes |
+List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md |
+false |
+v1.Volume array |
++ |
containers |
+List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/containers.md |
+true |
+v1.Container array |
++ |
restartPolicy |
+Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#restartpolicy |
+false |
+string |
++ |
terminationGracePeriodSeconds |
+Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
+false |
+integer (int64) |
++ |
activeDeadlineSeconds |
+Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
+false |
+integer (int64) |
++ |
dnsPolicy |
+Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst". |
+false |
+string |
++ |
nodeSelector |
+NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.2/docs/user-guide/node-selection/README.md |
+false |
++ | + |
serviceAccountName |
+ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.2/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://releases.k8s.io/release-1.2/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod |
+false |
+v1.LocalObjectReference array |
++ |
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
postStart |
+PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.2/docs/user-guide/container-environment.md#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://releases.k8s.io/release-1.2/docs/user-guide/container-environment.md#hook-details |
+false |
++ | + |
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 |
++ | + |
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
endpoints |
+EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod |
+true |
+string |
++ |
path |
+Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod |
+true |
+string |
++ |
readOnly |
+ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod |
+false |
+boolean |
+false |
+
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 |
++ |
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/release-1.2/docs/devel/api-conventions.md#types-kinds" |
+false |
+string |
++ |
name |
+Name of the referent; More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
+false |
+string |
++ |
apiVersion |
+API version of the referent |
+false |
+string |
++ |
subresource |
+Subresource name of the referent |
+false |
+string |
++ |
represents a scaling request for a resource.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object metadata; More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata. |
+false |
++ | + |
spec |
+defines the behavior of the scale. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status. |
+false |
++ | + |
status |
+current status of the scale. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status. Read-only. |
+false |
++ | + |
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
monitors |
+A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
+true |
+string array |
++ |
image |
+The rados image name. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
+true |
+string |
++ |
fsType |
+Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#rbd |
+false |
+string |
++ |
pool |
+The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it. |
+true |
+string |
++ |
user |
+The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
+true |
+string |
++ |
keyring |
+Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
+true |
+string |
++ |
secretRef |
+SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is empty. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
+true |
++ | + |
readOnly |
+ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
+false |
+boolean |
+false |
+
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://releases.k8s.io/release-1.2/docs/user-guide/labels.md#label-selectors |
+false |
++ | + |
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://releases.k8s.io/release-1.2/docs/user-guide/labels.md#label-selectors |
+false |
+string |
++ |
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
server |
+Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs |
+true |
+string |
++ |
path |
+Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs |
+true |
+string |
++ |
readOnly |
+ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#nfs |
+false |
+boolean |
+false |
+
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard list metadata. |
+false |
++ | + |
items |
+Items is the list of Deployments. |
+true |
+v1beta1.Deployment array |
++ |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/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 |
++ | + |
rollbackTo |
+The config of this deployment rollback. |
+true |
++ | + |
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 |
++ |
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 |
++ |
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) |
++ |
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
targetWWNs |
+Required: FC target world wide names (WWNs) |
+true |
+string array |
++ |
lun |
+Required: FC target lun number |
+true |
+integer (int32) |
++ |
fsType |
+Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
+false |
+string |
++ |
readOnly |
+Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
+false |
+boolean |
+false |
+
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 |
++ |
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 |
++ | + |
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 |
++ | + |
JobList is a collection of jobs.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard list metadata More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
+false |
++ | + |
items |
+Items is the list of Job. |
+true |
+v1beta1.Job array |
++ |
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
+false |
+string |
++ |
group |
+The group attribute of the resource associated with the status StatusReason. |
+false |
+string |
++ |
kind |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.2/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) |
++ |
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 |
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 |
++ |
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 |
-
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
name |
-Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
-false |
-string |
-- |
generateName |
-GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. |
-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 |
-- |
deletionTimestamp |
-DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested. |
-false |
-string |
-- |
deletionGracePeriodSeconds |
-Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
-false |
-integer (int64) |
-- |
labels |
-Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.2/docs/user-guide/labels.md |
-false |
-- | - |
annotations |
-Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.2/docs/user-guide/annotations.md |
-false |
-- | - |
observedGeneration
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
false
integer (int64)
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://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md#what-is-a-replication-controller |
+fullyLabeledReplicas |
+The number of pods that have labels matching the labels of the pod template of the replicaset. |
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://releases.k8s.io/release-1.2/docs/user-guide/labels.md#label-selectors |
+observedGeneration |
+ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
false |
-- | - |
template |
-Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md#pod-template |
-false |
-- | - |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/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 |
-- | - |
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://releases.k8s.io/release-1.2/docs/user-guide/labels.md#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://releases.k8s.io/release-1.2/docs/user-guide/replication-controller.md#pod-template |
-true |
-+ | integer (int64) |
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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#hostpath |
+true |
+string |
++ |
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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#hostpath |
-true |
-string |
-- |
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 |
-
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
targetPortal |
-iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
-true |
-string |
-- |
iqn |
-Target iSCSI Qualified Name. |
-true |
-string |
-- |
lun |
-iSCSI target lun number. |
-true |
-integer (int32) |
-- |
iscsiInterface |
-Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport. |
-false |
-string |
-- |
fsType |
-Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#iscsi |
-false |
-string |
-- |
readOnly |
-ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
-false |
-boolean |
-false |
-
| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
type |
-the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR |
-false |
-string |
-- |
object |
-the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR |
-false |
-string |
-- |
IngressList is a collection of Ingress.
-kind |
-Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
+type |
+the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR |
false |
string |
|
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
-false |
-string |
-- | ||
metadata |
-Standard object’s metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
-false |
-- | - | ||
items |
-Items is the list of Ingress. |
-true |
-v1beta1.Ingress array |
-- |
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -||
|---|---|---|---|---|---|---|
medium |
-What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#emptydir |
+object |
+the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR |
false |
string |
@@ -2820,46 +4479,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i |
describes the attributes of a scale subresource
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
replicas |
-desired number of instances for the scaled object. |
-false |
-integer (int32) |
-- |
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
-PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
claimName |
-ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
-true |
-string |
-- |
readOnly |
-Will force the ReadOnly setting in VolumeMounts. Default false. |
-false |
-boolean |
-false |
-
Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
datasetName |
-Required: the volume name. This is going to be store on metadata → name on the payload for Flocker |
-true |
-string |
-- |
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
selfLink |
-SelfLink is a URL representing this object. Populated by the system. Read-only. |
-false |
-string |
-- |
resourceVersion |
-String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#concurrency-control-and-consistency |
-false |
-string |
-- |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
-false |
-string |
-- |
metadata |
-Standard object metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
-false |
-- | - |
spec |
-behaviour of autoscaler. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status. |
-false |
-- | - |
status |
-current information about the autoscaler. |
-false |
-- | - |
| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
revision |
-The revision to rollback to. If set to 0, rollbck to the last revision. |
-false |
-integer (int64) |
-- |
Adapts a Secret into a volume.
-The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
secretName |
-Name of the secret in the pod’s namespace to use. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#secrets |
-false |
-string |
-- |
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
driver |
-Driver is the name of the driver to use for this volume. |
-true |
-string |
-- |
fsType |
-Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
-false |
-string |
-- |
secretRef |
-Optional: SecretRef is reference to the authentication secret for User, default is empty. |
-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 |
-- | - |
EnvVarSource represents a source for the value of an EnvVar.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
fieldRef |
-Selects a field of the pod; only name and namespace are supported. |
-false |
-- | - |
configMapKeyRef |
-Selects a key of a ConfigMap. |
-false |
-- | - |
secretKeyRef |
-Selects a key of a secret in the pod’s namespace |
-false |
-- | - |
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 |
-- |
lastTransitionTime |
-Last time the condition transit from one status to another. |
-false |
-string |
-- |
reason |
-(brief) reason for the condition’s last transition. |
-false |
-string |
-- |
message |
-Human readable message indicating details about last transition. |
-false |
-string |
-- |
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 |
-- |
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 |
-- |
DeleteOptions may be provided when deleting an API object
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
kind |
-Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/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. |
-true |
-integer (int64) |
-- |
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/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
-false |
-string |
-- |
metadata |
-Standard list metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata |
-false |
-- | - |
items |
-Items is a list of daemon sets. |
-true |
-v1beta1.DaemonSet array |
-- |
Volume represents a named volume in a pod that may be accessed by any container in the pod.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
name |
-Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
-true |
-string |
-- |
hostPath |
-HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#hostpath |
-false |
-- | - |
emptyDir |
-EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#secrets |
-false |
-- | - |
nfs |
-NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#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/release-1.2/examples/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/release-1.2/examples/glusterfs/README.md |
-false |
-- | - |
persistentVolumeClaim |
-PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#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/release-1.2/examples/rbd/README.md |
-false |
-- | - |
flexVolume |
-FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future. |
-false |
-- | - |
cinder |
-Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.2/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 |
-- | - |
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://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes |
-false |
-integer (int32) |
-- |
timeoutSeconds |
-Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#container-probes |
-false |
-integer (int32) |
-- |
periodSeconds |
-How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
-false |
-integer (int32) |
-- |
successThreshold |
-Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
-false |
-integer (int32) |
-- |
failureThreshold |
-Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
-false |
-integer (int32) |
-- |
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 |
-- | - |
SecretKeySelector selects a key of a Secret.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
name |
-Name of the referent. More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
-false |
-string |
-- |
key |
-The key of the secret to select from. Must be a valid secret key. |
-true |
-string |
-- |
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. |
-true |
-- | - |
PodSpec is a description of a pod.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
volumes |
-List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md |
-false |
-v1.Volume array |
-- |
containers |
-List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/containers.md |
-true |
-v1.Container array |
-- |
restartPolicy |
-Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#restartpolicy |
-false |
-string |
-- |
terminationGracePeriodSeconds |
-Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
-false |
-integer (int64) |
-- |
activeDeadlineSeconds |
-Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
-false |
-integer (int64) |
-- |
dnsPolicy |
-Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst". |
-false |
-string |
-- |
nodeSelector |
-NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.2/docs/user-guide/node-selection/README.md |
-false |
-- | - |
serviceAccountName |
-ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.2/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://releases.k8s.io/release-1.2/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod |
-false |
-v1.LocalObjectReference array |
-- |
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 |
-- |
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
postStart |
-PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.2/docs/user-guide/container-environment.md#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://releases.k8s.io/release-1.2/docs/user-guide/container-environment.md#hook-details |
-false |
-- | - |
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
endpoints |
-EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod |
-true |
-string |
-- |
path |
-Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod |
-true |
-string |
-- |
readOnly |
-ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.2/examples/glusterfs/README.md#create-a-pod |
-false |
-boolean |
-false |
-
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 |
-- | - |
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 |
-- |
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/release-1.2/docs/devel/api-conventions.md#types-kinds" |
-false |
-string |
-- |
name |
-Name of the referent; More info: http://releases.k8s.io/release-1.2/docs/user-guide/identifiers.md#names |
-false |
-string |
-- |
apiVersion |
-API version of the referent |
-false |
-string |
-- |
subresource |
-Subresource name of the referent |
-false |
-string |
-- |
represents a scaling request for a resource.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
kind |
-Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#types-kinds |
-false |
-string |
-- |
apiVersion |
-APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#resources |
-false |
-string |
-- |
metadata |
-Standard object metadata; More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#metadata. |
-false |
-- | - |
spec |
-defines the behavior of the scale. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status. |
-false |
-- | - |
status |
-current status of the scale. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-status. Read-only. |
-false |
-- | - |
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
-| Name | -Description | -Required | -Schema | -Default | -
|---|---|---|---|---|
monitors |
-A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
-true |
-string array |
-- |
image |
-The rados image name. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
-true |
-string |
-- |
fsType |
-Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.2/docs/user-guide/volumes.md#rbd |
-false |
-string |
-- |
pool |
-The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it. |
-true |
-string |
-- |
user |
-The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
-true |
-string |
-- |
keyring |
-Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
-true |
-string |
-- |
secretRef |
-SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is empty. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
-true |
-- | - |
readOnly |
-ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it |
-false |
-boolean |
-false |
-