diff --git a/config.toml b/config.toml index 08ad4bff74b97..23c0a9373aba0 100644 --- a/config.toml +++ b/config.toml @@ -45,17 +45,24 @@ time_format_blog = "Monday, January 02, 2006" description = "Production-Grade Container Orchestration" showedit = true -latest = "v1.10" +latest = "v1.11" -fullversion = "v1.10.3" -version = "v1.10" +fullversion = "v1.11.0" +version = "v1.11" githubbranch = "master" -docsbranch = "master" +docsbranch = "release-1.11" deprecated = false currentUrl = "https://kubernetes.io/docs/home/" nextUrl = "http://kubernetes-io-vnext-staging.netlify.com/" githubWebsiteRepo = "github.com/kubernetes/website" +[[params.versions]] +fullversion = "v1.11.0" +version = "v1.11" +githubbranch = "v1.11.0" +docsbranch = "release-1.11" +url = "https://kubernetes.io" + [[params.versions]] fullversion = "v1.10.3" version = "v1.10" diff --git a/content/en/docs/concepts/architecture/nodes.md b/content/en/docs/concepts/architecture/nodes.md index e52dc0eb380c5..9551a58e5bd29 100644 --- a/content/en/docs/concepts/architecture/nodes.md +++ b/content/en/docs/concepts/architecture/nodes.md @@ -46,6 +46,7 @@ The `conditions` field describes the status of all `Running` nodes. | `OutOfDisk` | `True` if there is insufficient free space on the node for adding new pods, otherwise `False` | | `Ready` | `True` if the node is healthy and ready to accept pods, `False` if the node is not healthy and is not accepting pods, and `Unknown` if the node controller has not heard from the node in the last `node-monitor-grace-period` (default is 40 seconds) | | `MemoryPressure` | `True` if pressure exists on the node memory -- that is, if the node memory is low; otherwise `False` | +| `PIDPressure` | `True` if pressure exists on the processes -- that is, if there are too many processes on the node; otherwise `False` | | `DiskPressure` | `True` if pressure exists on the disk size -- that is, if the disk capacity is low; otherwise `False` | | `NetworkUnavailable` | `True` if the network for the node is not correctly configured, otherwise `False` | | `ConfigOK` | `True` if the kubelet is correctly configured, otherwise `False` | diff --git a/content/en/docs/concepts/configuration/manage-compute-resources-container.md b/content/en/docs/concepts/configuration/manage-compute-resources-container.md index 79d4a87f293ac..02825b81f83fb 100644 --- a/content/en/docs/concepts/configuration/manage-compute-resources-container.md +++ b/content/en/docs/concepts/configuration/manage-compute-resources-container.md @@ -144,9 +144,7 @@ When using Docker: multiplied by 100. The resulting value is the total amount of CPU time that a container can use every 100ms. A container cannot use more than its share of CPU time during this interval. - {{< note >}} - **Note**: The default quota period is 100ms. The minimum resolution of CPU quota is 1ms. - {{< /note >}} + {{< note >}}**Note**: The default quota period is 100ms. The minimum resolution of CPU quota is 1ms.{{ {{}}} - The `spec.containers[].resources.limits.memory` is converted to an integer, and used as the value of the @@ -209,12 +207,10 @@ $ kubectl describe nodes e2e-test-minion-group-4lw4 Name: e2e-test-minion-group-4lw4 [ ... lines removed for clarity ...] Capacity: - alpha.kubernetes.io/nvidia-gpu: 0 cpu: 2 memory: 7679792Ki pods: 110 Allocatable: - alpha.kubernetes.io/nvidia-gpu: 0 cpu: 1800m memory: 7474992Ki pods: 110 @@ -300,10 +296,10 @@ Container in the Pod was terminated and restarted five times. You can call `kubectl get pod` with the `-o go-template=...` option to fetch the status of previously terminated Containers: -```shell +```shell{% raw %} [13:59:01] $ kubectl get pod -o go-template='{{range.status.containerStatuses}}{{"Container Name: "}}{{.name}}{{"\r\nLastState: "}}{{.lastState}}{{end}}' simmemleak-hra99 Container Name: simmemleak -LastState: map[terminated:map[exitCode:137 reason:OOM Killed startedAt:2015-07-07T20:58:43Z finishedAt:2015-07-07T20:58:43Z containerID:docker://0e4095bba1feccdfe7ef9fb6ebffe972b4b14285d5acdec6f0d3ae8a22fad8b2]] +LastState: map[terminated:map[exitCode:137 reason:OOM Killed startedAt:2015-07-07T20:58:43Z finishedAt:2015-07-07T20:58:43Z containerID:docker://0e4095bba1feccdfe7ef9fb6ebffe972b4b14285d5acdec6f0d3ae8a22fad8b2]]{% endraw %} ``` You can see that the Container was terminated because of `reason:OOM Killed`, @@ -545,6 +541,4 @@ consistency across providers and platforms. * [ResourceRequirements](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#resourcerequirements-v1-core) -{{% /capture %}} - - +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/configuration/pod-priority-preemption.md b/content/en/docs/concepts/configuration/pod-priority-preemption.md index 9564247fe1077..e04be6d64f79d 100644 --- a/content/en/docs/concepts/configuration/pod-priority-preemption.md +++ b/content/en/docs/concepts/configuration/pod-priority-preemption.md @@ -59,6 +59,26 @@ scheduler. After the feature is disabled, the existing Pods keep their priority fields, but preemption is disabled, and priority fields are ignored, and you cannot set `priorityClassName` in new Pods. +## How to disable preemption + +In Kubernetes 1.11 and later, preemption is controlled by a kube-scheduler flag `disablePreemption`, which is set to `false` by default. + +If you want to disable preemption, just set `disablePreemption` to true. This will keep pod priority enabled while preemption is disabled. Here is a sample configuration: + +```yaml +apiVersion: componentconfig/v1alpha1 +kind: KubeSchedulerConfiguration +algorithmSource: + provider: DefaultProvider + +... + +disablePreemption: true + +``` + +Please note: although preemption of scheduler is enabled by default, preemption will not happen if `PodPriority` feature is not available. + ## PriorityClass A PriorityClass is a non-namespaced object that defines a mapping from a priority diff --git a/content/en/docs/concepts/configuration/taint-and-toleration.md b/content/en/docs/concepts/configuration/taint-and-toleration.md index 0497646916083..07b5af707cb2a 100644 --- a/content/en/docs/concepts/configuration/taint-and-toleration.md +++ b/content/en/docs/concepts/configuration/taint-and-toleration.md @@ -204,23 +204,23 @@ running on the node as follows * pods that tolerate the taint with a specified `tolerationSeconds` remain bound for the specified amount of time -In addition, Kubernetes 1.6 has alpha -support for representing node problems. In other words, the node controller -automatically taints a node when certain condition is true. The built-in taints -currently include: +In addition, Kubernetes 1.6 introduced alpha support for representing node +problems. In other words, the node controller automatically taints a node when +certain condition is true. The following taints are built in: * `node.kubernetes.io/not-ready`: Node is not ready. This corresponds to the NodeCondition `Ready` being "`False`". - * `node.alpha.kubernetes.io/unreachable`: Node is unreachable from the node + * `node.kubernetes.io/unreachable`: Node is unreachable from the node controller. This corresponds to the NodeCondition `Ready` being "`Unknown`". * `node.kubernetes.io/out-of-disk`: Node becomes out of disk. * `node.kubernetes.io/memory-pressure`: Node has memory pressure. * `node.kubernetes.io/disk-pressure`: Node has disk pressure. * `node.kubernetes.io/network-unavailable`: Node's network is unavailable. - * `node.cloudprovider.kubernetes.io/uninitialized`: When kubelet is started - with "external" cloud provider, it sets this taint on a node to mark it - as unusable. When a controller from the cloud-controller-manager initializes - this node, kubelet removes this taint. + * `node.kubernetes.io/unschedulable`: Node is unschedulable. + * `node.cloudprovider.kubernetes.io/uninitialized`: When the kubelet is started + with "external" cloud provider, this taint is set on a node to mark it + as unusable. After a controller from the cloud-controller-manager initializes + this node, the kubelet removes this taint. When the `TaintBasedEvictions` alpha feature is enabled (you can do this by including `TaintBasedEvictions=true` in `--feature-gates` for Kubernetes controller manager, @@ -277,17 +277,15 @@ Version 1.8 introduces an alpha feature that causes the node controller to creat Node conditions. When this feature is enabled (you can do this by including `TaintNodesByCondition=true` in the `--feature-gates` command line flag to the scheduler, such as `--feature-gates=FooBar=true,TaintNodesByCondition=true`), the scheduler does not check Node conditions; instead the scheduler checks taints. This assures that Node conditions don't affect what's scheduled onto the Node. The user can choose to ignore some of the Node's problems (represented as Node conditions) by adding appropriate Pod tolerations. -To make sure that turning on this feature doesn't break DaemonSets, starting in version 1.8, the DaemonSet controller automatically adds the following `NoSchedule` tolerations to all daemons: +Starting in Kubernetes 1.8, the DaemonSet controller automatically adds the +following `NoSchedule` tolerations to all daemons, to prevent DaemonSets from +breaking. * `node.kubernetes.io/memory-pressure` * `node.kubernetes.io/disk-pressure` * `node.kubernetes.io/out-of-disk` (*only for critical pods*) + * `node.kubernetes.io/unschedulable` (1.10 or later) + * `node.kubernetes.io/network-unavailable` (*host network only*) -The above settings ensure backward compatibility, but we understand they may not fit all user's needs, which is why -cluster admin may choose to add arbitrary tolerations to DaemonSets. - -{{% /capture %}} - -{{% capture whatsnext %}} - -{{% /capture %}} \ No newline at end of file +Adding these tolerations ensures backward compatibility. You can also add +arbitrary tolerations to DaemonSets. diff --git a/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md b/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md index d8c66a4520206..efab74152a30a 100644 --- a/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md +++ b/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md @@ -8,7 +8,11 @@ weight: 20 --- {{% capture overview %}} -This page explains [*custom resources*](/docs/concepts/api-extension/custom-resources/), which are extensions of the Kubernetes API. This page explains when to add a custom resource to your Kubernetes cluster and when to use a standalone service. It describes the two methods for adding custom resources and how to choose between them. + +This page explains *custom resources*, which are extensions of the Kubernetes +API, including when to add a custom resource to your Kubernetes cluster and when +to use a standalone service. It describes the two methods for adding custom +resources and how to choose between them. {{% /capture %}} @@ -103,20 +107,20 @@ Use a custom resource (CRD or Aggregated API) if most of the following apply: Kubernetes provides two ways to add custom resources to your cluster: -- [Custom Resource Definitions](/docs/concepts/api-extension/custom-resources/) (CRDs) are easier to use: they do not require any programming in some cases. +- CRDs are simple and can be created without any programming. - [API Aggregation](/docs/concepts/api-extension/apiserver-aggregation/) requires programming, but allows more control over API behaviors like how data is stored and conversion between API versions. Kubernetes provides these two options to meet the needs of different users, so that neither ease of use nor flexibility are compromised. Aggregated APIs are subordinate APIServers that sit behind the primary API server, which acts as a proxy. This arrangement is called [API Aggregation](/docs/concepts/api-extension/apiserver-aggregation/) (AA). To users, it simply appears that the Kubernetes API is extended. -Custom Resource Definitions (CRDS) allow users to create new types of resources without adding another APIserver. You do not need to understand API Aggregation to use CRDs. +CRDs allow users to create new types of resources without adding another APIserver. You do not need to understand API Aggregation to use CRDs. -Regardless of whether they are installed via CRDs or AA, the new resources are called Custom Resources to distinguish them from built-in Kubernetes resources (like pods). +Regardless of how they are installed, the new resources are referred to as Custom Resources to distinguish them from built-in Kubernetes resources (like pods). ## CustomResourceDefinitions -The [CustomResourceDefinition](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/) (CRD) API resource allows you to define custom resources. Defining a CRD object creates a new custom resource with a name and schema that you specify. The Kubernetes API serves and handles the storage of your custom resource. +The [CustomResourceDefinition](/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/) API resource allows you to define custom resources. Defining a CRD object creates a new custom resource with a name and schema that you specify. The Kubernetes API serves and handles the storage of your custom resource. This frees you from writing your own API server to handle the custom resource, but the generic nature of the implementation means you have less flexibility than with @@ -132,7 +136,7 @@ and setup a controller to handle events. ## API server aggregation -Usually, each resource in the Kubernetes API requires code that handles REST requests and manages persistent storage of objects. The main Kubernetes API server handles built-in resources like *pods* and *services*, and can also handle custom resources in a generic way through [CustomResourceDefinitions](#customresourcedefinitions). +Usually, each resource in the Kubernetes API requires code that handles REST requests and manages persistent storage of objects. The main Kubernetes API server handles built-in resources like *pods* and *services*, and can also handle custom resources in a generic way through [CRDs](#customresourcedefinitions). The [aggregation layer](/docs/concepts/api-extension/apiserver-aggregation/) allows you to provide specialized implementations for your custom resources by writing and deploying your own standalone API server. @@ -152,7 +156,7 @@ Typically, CRDs are a good fit if: CRDs are easier to create than Aggregated APIs. -| Custom Resource Definitions | Aggregated API | +| CRDs | Aggregated API | | --------------------------- | -------------- | | Do not require programming. Users can choose any language for a CRD controller. | Requires programming in Go and building binary and image. Users can choose any language for a CRD controller. | | No additional service to run; CRs are handled by API Server. | An additional service to create and that could fail. | diff --git a/content/en/docs/concepts/policy/pod-security-policy.md b/content/en/docs/concepts/policy/pod-security-policy.md index 3c998b63847a6..5c121d132ee47 100644 --- a/content/en/docs/concepts/policy/pod-security-policy.md +++ b/content/en/docs/concepts/policy/pod-security-policy.md @@ -414,7 +414,8 @@ minimum value of the first range as the default. Validates against all ranges. to be used by hostPath volumes. An empty list means there is no restriction on host paths used. This is defined as a list of objects with a single `pathPrefix` field, which allows hostPath volumes to mount a path that begins with an -allowed prefix. For example: +allowed prefix, and a `readOnly` field indicating it must be mounted read-only. +For example: ```yaml allowedHostPaths: @@ -422,11 +423,18 @@ allowedHostPaths: # disallows "/fool", "/etc/foo" etc. # "/foo/../" is never valid. - pathPrefix: "/foo" + readOnly: true # only allow read-only mounts ``` -_Note: There are many ways a container with unrestricted access to the host +{{< warning >}}**Warning:** There are many ways a container with unrestricted access to the host filesystem can escalate privileges, including reading data from other -containers, and abusing the credentials of system services, such as Kubelet._ +containers, and abusing the credentials of system services, such as Kubelet. + +Writeable hostPath directory volumes allow containers to write +to the filesystem in ways that let them traverse the host filesystem outside the `pathPrefix`. +`readOnly: true`, available in Kubernetes 1.11+, must be used on **all** `allowedHostPaths` +to effectively limit access to the specified `pathPrefix`. +{{< /warning >}} **ReadOnlyRootFilesystem** - Requires that containers must run with a read-only root filesystem (i.e. no writable layer). diff --git a/content/en/docs/concepts/storage/persistent-volumes.md b/content/en/docs/concepts/storage/persistent-volumes.md index 72b66b9807b55..ccda194f3d0c1 100644 --- a/content/en/docs/concepts/storage/persistent-volumes.md +++ b/content/en/docs/concepts/storage/persistent-volumes.md @@ -71,14 +71,13 @@ Pods use claims as volumes. The cluster inspects the claim to find the bound vol Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a `persistentVolumeClaim` in their Pod's volumes block. [See below for syntax details](#claims-as-volumes). ### Storage Object in Use Protection -{{< feature-state for_k8s_version="v1.10" state="beta" >}} The purpose of the Storage Object in Use Protection feature is to ensure that Persistent Volume Claims (PVCs) in active use by a pod and Persistent Volume (PVs) that are bound to PVCs are not removed from the system as this may result in data loss. {{< note >}} **Note:** PVC is in active use by a pod when the pod status is `Pending` and the pod is assigned to a node or the pod status is `Running`. {{< /note >}} -When the [Storage Object in Use Protection beta feature](/docs/tasks/administer-cluster/storage-object-in-use-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods, and also if admin deletes a PV that is bound to a PVC, the PV is not removed immediately. PV removal is postponed until the PV is not bound to a PVC any more. +When the [Storage Object in Use Protection feature](/docs/tasks/administer-cluster/storage-object-in-use-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods, and also if admin deletes a PV that is bound to a PVC, the PV is not removed immediately. PV removal is postponed until the PV is not bound to a PVC any more. You can see that a PVC is protected when the PVC's status is `Terminating` and the `Finalizers` list includes `kubernetes.io/pvc-protection`: @@ -169,20 +168,21 @@ However, the particular path specified in the custom recycler pod template in th ### Expanding Persistent Volumes Claims -Kubernetes 1.8 added Alpha support for expanding persistent volumes. In v1.9, the following volume types support expanding Persistent volume claims: +{{< feature-state for_k8s_version="v1.8" state="alpha" >}} +{{< feature-state for_k8s_version="v1.11" state="beta" >}} +Support for expanding PersistentVolumeClaims (PVCs) is now enabled by default. You can expand +the following types of volumes: * gcePersistentDisk * awsElasticBlockStore * Cinder * glusterfs * rbd +* Azure File +* Azure Disk +* Portworx -Administrator can allow expanding persistent volume claims by setting `ExpandPersistentVolumes` feature gate to true. Administrator -should also enable [`PersistentVolumeClaimResize` admission plugin](/docs/admin/admission-controllers/#persistentvolumeclaimresize) -to perform additional validations of volumes that can be resized. - -Once `PersistentVolumeClaimResize` admission plug-in has been turned on, resizing will only be allowed for storage classes -whose `allowVolumeExpansion` field is set to true. +You can only expand a PVC if its storage class's `allowVolumeExpansion` field is set to true. ``` yaml kind: StorageClass @@ -198,17 +198,33 @@ parameters: allowVolumeExpansion: true ``` -Once both feature gate and the aforementioned admission plug-in are turned on, a user can request larger volume for their `PersistentVolumeClaim` -by simply editing the claim and requesting a larger size. This in turn will trigger expansion of the volume that is backing the underlying `PersistentVolume`. +To request a larger volume for a PVC, edit the PVC object and specify a larger +size. This triggers expansion of the volume that backs the underlying `PersistentVolume`. A +new `PersistentVolume` is never created to satisfy the claim. Instead, an existing volume is resized. + +#### Resizing a volume containing a file system + +You can only resize volumes containing a file system if the file system is XFS, Ext3, or Ext4. -Under no circumstances will a new `PersistentVolume` be created to satisfy the claim. Kubernetes will instead attempt to resize the existing volume. +When a volume contains a file system, the file system is only resized when a new Pod is started using +the `PersistentVolumeClaim` in ReadWrite mode. Therefore, if a pod or deployment is using a volume and +you want to expand it, you need to delete or recreate the pod after the volume has been exxpanded by the cloud provider in the controller-manager. You can check the status of resize operation by running the `kubectl describe pvc` command: + +``` +kubectl describe pvc +``` -For expanding volumes containing a file system, file system resizing is only performed when a new Pod is started using the `PersistentVolumeClaim` in -ReadWrite mode. In other words, if a volume being expanded is used in a pod or deployment, you will need to delete and recreate the pod for file system -resizing to take place. Also, file system resizing is only supported for following file system types: +If the `PersistentVolumeClaim` has the status `FileSystemResizePending`, it is safe to recreate the pod using the PersistentVolumeClaim. -* XFS -* Ext3, Ext4 +#### Resizing an in-use PersistentVolumeClaim + +{{< feature-state for_k8s_version="v1.11" state="alpha" >}} + +Expanding in-use PVCs is an alpha feature. To use it, enable the `ExpandInUsePersistentVolumes` feature gate. +In this case, you don't need to delete and recreate a Pod or deployment that is using an existing PVC. +Any in-use PVC automatically becomes available to its Pod as soon as its file system has been expanded. +This feature has no effect on PVCs that are not in use by a Pod or deployment. You must create a Pod which +uses the PVC before the expansion can complete. {{< note >}} **Note:** Expanding EBS volumes is a time consuming operation. Also, there is a per-volume quota of one modification every 6 hours. @@ -223,7 +239,7 @@ resizing to take place. Also, file system resizing is only supported for followi * AWSElasticBlockStore * AzureFile * AzureDisk -* FC (Fibre Channel)** +* FC (Fibre Channel) * FlexVolume * Flocker * NFS @@ -239,8 +255,6 @@ resizing to take place. Also, file system resizing is only supported for followi * ScaleIO Volumes * StorageOS -Raw Block Support exists for these plugins only. - ## Persistent Volumes Each PV contains a spec and status, which is the specification and status of the volume. @@ -274,11 +288,14 @@ Currently, storage size is the only resource that can be set or requested. Futu ### Volume Mode -Prior to v1.9, the default behavior for all volume plugins was to create a filesystem on the persistent volume. With v1.9, the user can specify a `volumeMode` which will now support raw block devices in addition to file systems. Valid values for `volumeMode` are "Filesystem" or "Block". If left unspecified, `volumeMode` defaults to "Filesystem" internally. This is an optional API parameter. +{{< feature-state for_k8s_version="v1.9" state="alpha" >}} -{{< note >}} -**Note:** This feature is alpha in v1.9 and may change in the future. -{{< /note >}} +To enable this feature, enable the `BlockVolume` feature gate on the apiserver, controller-manager and the kubelet. + +Prior to Kubernetes 1.9, all volume plugins created a filesystem on the persistent volume. +Now, you can set the value of `volumeMode` to `raw` to use a raw block device, or `filesystem` +to use a filesystem. `filesystem` is the default if the value is omitted. This is an optional API +parameter. ### Access Modes @@ -501,7 +518,22 @@ spec: ## Raw Block Volume Support -Static provisioning support for Raw Block Volumes is included as an alpha feature for v1.9. With this change are some new API fields that need to be used to facilitate this functionality. Kubernetes v1.10 supports only Fibre Channel and Local Volume plugins for this feature. +{{< feature-state for_k8s_version="v1.9" state="alpha" >}} + +To enable support for raw block volumes, enable the `BlockVolume` feature gate on the +apiserver, controller-manager and the kubelet. + +The following volume plugins support raw block volumes, including dynamic provisioning where +applicable. + +* AWSElasticBlockStore +* AzureDisk +* Cinder +* FC (Fibre Channel) +* GCEPersistentDisk +* iSCSI +* Local volume +* RBD (Ceph Block Device) ### Persistent Volumes using a Raw Block Volume ```yaml diff --git a/content/en/docs/concepts/storage/storage-limits.md b/content/en/docs/concepts/storage/storage-limits.md new file mode 100644 index 0000000000000..2e3532cccf2bb --- /dev/null +++ b/content/en/docs/concepts/storage/storage-limits.md @@ -0,0 +1,73 @@ +--- +reviewers: +- jsafrane +- saad-ali +- thockin +- msau42 +title: Node-specific Volume Limits +content_template: templates/concept +--- + +{{% capture overview %}} + +This page describes the maximum number of volumes that can be attached +to a node for various cloud providers. + +Cloud providers like Google, Amazon, and Microsoft typically have a limit on +how many volumes can be attached to a node. It is important for Kubernetes to +respect those limits. Otherwise, Pods scheduled on a node could get stuck +waiting for volumes to attach. + +{{% /capture %}} + +{{% capture body %}} + +## Kubernetes default limits + +The Kubernetes scheduler has default limits on the number of volumes +that can be attached to a node: + + + + + + +
Cloud serviceMaximum volumes per node
Amazon Elastic Block Store (EBS)39
Google Persistent Disk16
Microsoft Azure Disk Storage16
+ +## Custom limits + +You can change these limits by setting the value of the +`KUBE_MAX_PD_VOLS` environment variable, and then starting the scheduler. + +Use caution if you set a limit that is higher than the default limit. Consult +the cloud provider's documentation to make sure that nodes can actually support +the limit you set. + +The limit applies to the entire cluster, so it affects all nodes. + +## Dynamic volume limits + +{{< feature-state state="alpha" for_k8s_version="v1.11" >}} + +Kubernetes 1.11 introduces dynamic volume limits based on node type. This +is an alpha feature that supports these services: + +- Amazon EBS +- Google Persistent Disk + +To enable dynamic volume limits, use the `AttachVolumeLimit` flag. + +When the dynamic volume limits feature is enabled, Kubernetes automatically +determines the node type and supports the appropriate number of attachable +volumes for the node. For example: + +* On +Google Compute Engine, +up to 128 volumes could be attached to a node, depending on the node type. + +* For Amazon EBS disks on M5/C5 instance types, Kubernetes would permit only 25 +volumes to be attached to a node. For other instance types on +Amazon Elastic Compute Cloud (EC2), +Kubernetes would permit 39 volumes to be attached. + +{{% /capture %}} diff --git a/content/en/docs/concepts/storage/volumes.md b/content/en/docs/concepts/storage/volumes.md index 6c6499fcc264e..bf27efb74f845 100644 --- a/content/en/docs/concepts/storage/volumes.md +++ b/content/en/docs/concepts/storage/volumes.md @@ -1018,6 +1018,43 @@ spec: claimName: my-lamp-site-data ``` +### Using subPath with expanded environment variables + +{{< feature-state for_k8s_version="v1.11" state="alpha" >}} + + +`subPath` directory names can also be constructed from Downward API environment variables. +Before you use this feature, you must enable the `VolumeSubpathEnvExpansion`feature gate. + +In this example, a Pod uses `subPath` to create a directory `pod1` within the hostPath volume `/var/log/pods`, using the pod name from the Downward API. The host directory `/var/log/pods/pod1` is mounted at `/logs` in the container. + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: pod1 +spec: + containers: + - name: container1 + env: + - name: POD_NAME + valueFrom: + fieldRef: + apiVersion: v1 + fieldPath: metadata.name + image: busybox + command: [ "sh", "-c", "while [ true ]; do echo 'Hello'; sleep 10; done | tee -a /logs/hello.txt" ] + volumeMounts: + - name: workdir1 + mountPath: /logs + subPath: $(POD_NAME) + restartPolicy: Never + volumes: + - name: workdir1 + hostPath: + path: /var/log/pods +``` + ## Resources The storage media (Disk, SSD, etc.) of an `emptyDir` volume is determined by the @@ -1116,6 +1153,26 @@ persistent volume: secret is required. If the secret object contains more than one secret, all secrets are passed. +#### CSI raw block volume support + +{{< feature-state for_k8s_version="v1.11" state="alpha" >}} + +Starting with version 1.11, CSI introduced support for raw block volumes, which +relies on the raw block volume feature that was introduced in a previous version of +Kubernetes. This feature will make it possible for vendors with external CSI drivers to +implement raw block volumes support in Kubernetes workloads. + +CSI block volume support is feature-gated and turned off by default. To run CSI with +block volume support enabled, a cluster administrator must enable the feature for each +Kubernetes component using the following feature gate flags: + +``` +--feature-gates=BlockVolume=true,CSIBlockVolume=true +``` + +Learn how to +[setup your PV/PVC with raw block volume support](/docs/concepts/storage/persistent-volumes/#raw-block-volume-support). + ### FlexVolume `FlexVolume` is an out-of-tree plugin interface that has existed in Kubernetes diff --git a/content/en/docs/concepts/workloads/controllers/daemonset.md b/content/en/docs/concepts/workloads/controllers/daemonset.md index 15237bf250612..1ebedf06f27c7 100644 --- a/content/en/docs/concepts/workloads/controllers/daemonset.md +++ b/content/en/docs/concepts/workloads/controllers/daemonset.md @@ -98,7 +98,9 @@ If you do not specify either, then the DaemonSet controller will create Pods on ## How Daemon Pods are Scheduled -Normally, the machine that a Pod runs on is selected by the Kubernetes scheduler. However, Pods +### Scheduled by DaemonSet controller (default) + +Normally, the machine that a Pod runs on is selected by the Kubernetes scheduler. However, Pods created by the DaemonSet controller have the machine already selected (`.spec.nodeName` is specified when the Pod is created, so it is ignored by the scheduler). Therefore: @@ -107,29 +109,72 @@ when the Pod is created, so it is ignored by the scheduler). Therefore: - The DaemonSet controller can make Pods even when the scheduler has not been started, which can help cluster bootstrap. -Daemon Pods do respect [taints and tolerations](/docs/concepts/configuration/taint-and-toleration), -but they are created with `NoExecute` tolerations for the following taints with no `tolerationSeconds`: - - `node.kubernetes.io/not-ready` - - `node.alpha.kubernetes.io/unreachable` +### Scheduled by default scheduler + +{{< feature-state state="alpha" for-kubernetes-version="1.11" >}} + +A DaemonSet ensures that all eligible nodes run a copy of a Pod. Normally, the +node that a Pod runs on is selected by the Kubernetes scheduler. However, +DaemonSet pods are created and scheduled by the DaemonSet controller instead. +That introduces the following issues: + + * Inconsistent Pod behavior: Normal Pods waiting to be scheduled are created + and in `Pending` state, but DaemonSet pods are not created in `Pending` + state. This is confusing to the user. + * [Pod preemption](/docs/concepts/configuration/pod-priority-preemption/) + is handled by default scheduler. When preemption is enabled, the DaemonSet controller + will make scheduling decisions without considering pod priority and preemption. + +`ScheduleDaemonSetPods` allows you to schedule DaemonSets using the default +scheduler instead of the DaemonSet controller, by adding the `NodeAffinity` term +to the DaemonSet pods, instead of the `.spec.nodeName` term. The default +scheduler is then used to bind the pod to the target host. If node affinity of +the DaemonSet pod already exists, it is replaced. The DaemonSet controller only +performs these operations when creating or modifying DaemonSet pods, and no +changes are made to the `spec.template` of the DaemonSet. + +```yaml +nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchFields: + - key: metadata.name + operator: In + values: + - target-host-name +``` + +In addition, `node.kubernetes.io/unschedulable:NoSchedule` toleration is added +automatically to DaemonSet Pods. The DaemonSet controller ignores +`unschedulable` Nodes when scheduling DaemonSet Pods. You must enable +`TaintModesByCondition` to ensure that the default scheduler behaves the same +way and schedules DaemonSet pods on `unschedulable` nodes. + +When this feature and `TaintNodesByCondition` are enabled together, if DaemonSet +uses the host network, you must also add the +`node.kubernetes.io/network-unavailable:NoSchedule toleration`. + -This ensures that when the `TaintBasedEvictions` alpha feature is enabled, -they will not be evicted when there are node problems such as a network partition. (When the -`TaintBasedEvictions` feature is not enabled, they are also not evicted in these scenarios, but -due to hard-coded behavior of the NodeController rather than due to tolerations). +### Taints and Tolerations - They also tolerate following `NoSchedule` taints: +Although Daemon Pods respect +[taints and tolerations](/docs/concepts/configuration/taint-and-toleration), +the following tolerations are added to DamonSet Pods automatically according to +the related features. - - `node.kubernetes.io/memory-pressure` - - `node.kubernetes.io/disk-pressure` +| Toleration Key | Effect | Alpha Features | Version | Description | +| ---------------------------------------- | ---------- | ------------------------------------------------------------ | ------- | ------------------------------------------------------------ | +| `node.kubernetes.io/not-ready` | NoExecute | `TaintBasedEvictions` | 1.8+ | when `TaintBasedEvictions` is enabled,they will not be evicted when there are node problems such as a network partition. | +| `node.kubernetes.io/unreachable` | NoExecute | `TaintBasedEvictions` | 1.8+ | when `TaintBasedEvictions` is enabled,they will not be evicted when there are node problems such as a network partition. | +| `node.kubernetes.io/disk-pressure` | NoSchedule | `TaintNodesByCondition` | 1.8+ | | +| `node.kubernetes.io/memory-pressure` | NoSchedule | `TaintNodesByCondition` | 1.8+ | | +| `node.kubernetes.io/unschedulable` | NoSchedule | `ScheduleDaemonSetPods`, `TaintNodesByCondition` | 1.11+ | When ` ScheduleDaemonSetPods` is enabled, ` TaintNodesByCondition` is necessary to make sure DaemonSet pods tolerate unschedulable attributes by default scheduler. | +| `node.kubernetes.io/network-unavailable` | NoSchedule | `ScheduleDaemonSetPods`, `TaintNodesByCondition`, hostnework | 1.11+ | When ` ScheduleDaemonSetPods` is enabled, ` TaintNodesByCondition` is necessary to make sure DaemonSet pods, who uses host network, tolerate network-unavailable attributes by default scheduler. | +| `node.kubernetes.io/out-of-disk` | NoSchedule | `ExperimentalCriticalPodAnnotation` (critical pod only), `TaintNodesByCondition` | 1.8+ | | -When the support to critical pods is enabled and the pods in a DaemonSet are -labeled as critical, the Daemon pods are created with an additional -`NoSchedule` toleration for the `node.kubernetes.io/out-of-disk` taint. -Note that all above `NoSchedule` taints above are created only in version 1.8 or later if the alpha feature `TaintNodesByCondition` is enabled. -Also note that the `node-role.kubernetes.io/master` `NoSchedule` toleration specified in the above example is needed on 1.6 or later to schedule on *master* nodes as this is not a default toleration. ## Communicating with Daemon Pods diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 3926ed9a1681c..56713abd1b43d 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -11,12 +11,11 @@ weight: 70 * [Kubernetes API Overview](/docs/reference/using-api/api-overview/) - Overview of the API for Kubernetes. * Kubernetes API Versions - * [1.10](/docs/reference/generated/kubernetes-api/v1.10/) + * [1.11](/docs/reference/generated/kubernetes-api/v1.11/) + * [1.10](https://v1-10.docs/kubernetes.io/docs/reference/) * [1.9](https://v1-9.docs.kubernetes.io/docs/reference/) * [1.8](https://v1-8.docs.kubernetes.io/docs/reference/) * [1.7](https://v1-7.docs.kubernetes.io/docs/reference/) - * [1.6](https://v1-6.docs.kubernetes.io/docs/reference/) - * [1.5](https://v1-5.docs.kubernetes.io/docs/reference/) ## API Client Libraries diff --git a/content/en/docs/reference/access-authn-authz/admission-controllers.md b/content/en/docs/reference/access-authn-authz/admission-controllers.md index cfcf69225cbc6..c23357b4f7863 100644 --- a/content/en/docs/reference/access-authn-authz/admission-controllers.md +++ b/content/en/docs/reference/access-authn-authz/admission-controllers.md @@ -22,7 +22,7 @@ is authenticated and authorized. The controllers consist of the administrator. In that list, there are two special controllers: MutatingAdmissionWebhook and ValidatingAdmissionWebhook. These execute the mutating and validating (respectively) [admission control -webhooks](/docs/admin/extensible-admission-controllers/#external-admission-webhooks) +webhooks](/docs/admin/extensible-admission-controllers.md#external-admission-webhooks) which are configured in the API. Admission controllers may be "validating", "mutating", or both. Mutating @@ -144,6 +144,8 @@ enabling this admission controller. This admission controller mitigates the problem where the API server gets flooded by event requests. The cluster admin can specify event rate limits by: + * Ensuring that `eventratelimit.admission.k8s.io/v1alpha1=true` is included in the + `--runtime-config` flag for the API server; * Enabling the `EventRateLimit` admission controller; * Referencing an `EventRateLimit` configuration file from the file provided to the API server's command line flag `--admission-control-config-file`: @@ -225,8 +227,7 @@ plugins: ... ``` -The ImagePolicyWebhook config file must reference a [kubeconfig](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) -formatted file which sets up the connection to the backend. It is required that the backend communicate over TLS. +The ImagePolicyWebhook config file must reference a [kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) formatted file which sets up the connection to the backend. It is required that the backend communicate over TLS. The kubeconfig file's cluster field must point to the remote service, and the user field must contain the returned authorizer. @@ -245,7 +246,7 @@ users: client-certificate: /path/to/cert.pem # cert for the webhook admission controller to use client-key: /path/to/key.pem # key matching the cert ``` -For additional HTTP configuration, refer to the [kubeconfig](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) documentation. +For additional HTTP configuration, refer to the [kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) documentation. #### Request Payloads @@ -320,18 +321,7 @@ In any case, the annotations are provided by the user and are not validated by K The admission controller determines the initializers of a resource based on the existing `InitializerConfiguration`s. It sets the pending initializers by modifying the metadata of the resource to be created. -For more information, please check [Dynamic Admission Control](/docs/admin/extensible-admission-controllers/). - -### InitialResources (experimental) - -This admission controller observes pod creation requests. If a container omits compute resource requests and limits, -then the admission controller auto-populates a compute resource request based on historical usage of containers running the same image. -If there is not enough data to make a decision the Request is left unchanged. -When the admission controller sets a compute resource request, it does this by *annotating* -the pod spec rather than mutating the `container.resources` fields. -The annotations added contain the information on what compute resources were auto-populated. - -See the [InitialResources proposal](https://git.k8s.io/community/contributors/design-proposals/autoscaling/initial-resources.md) for more details. +For more information, please check [Dynamic Admission Control](/docs/admin/extensible-admission-controllers.md). ### LimitPodHardAntiAffinityTopology @@ -346,7 +336,7 @@ your Kubernetes deployment, you MUST use this admission controller to enforce th be used to apply default resource requests to Pods that don't specify any; currently, the default LimitRanger applies a 0.1 CPU requirement to all Pods in the `default` namespace. -See the [limitRange design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_limit_range.md) and the [example of Limit Range](/docs/tasks/administer-cluster/memory-default-namespace/) for more details. +See the [limitRange design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_limit_range.md) and the [example of Limit Range](/docs/tasks/configure-pod-container/limit-range/) for more details. ### MutatingAdmissionWebhook (beta in 1.9) @@ -406,6 +396,7 @@ namespace. In order to enforce integrity of that process, we strongly recommend This admission controller limits the `Node` and `Pod` objects a kubelet can modify. In order to be limited by this admission controller, kubelets must use credentials in the `system:nodes` group, with a username in the form `system:node:`. Such kubelets will only be allowed to modify their own `Node` API object, and only modify `Pod` API objects that are bound to their node. +In Kubernetes 1.11+, kubelets are not allowed to update or remove taints from their `Node` API object. Future versions may add additional restrictions to ensure kubelets have the minimal set of permissions required to operate correctly. ### OwnerReferencesPermissionEnforcement @@ -424,7 +415,9 @@ It helps ensure the Pods and the PersistentVolumes mounted are in the same region and/or zone. If the admission controller doesn't support automatic labelling your PersistentVolumes, you may need to add the labels manually to prevent pods from mounting volumes from -a different zone. PersistentVolumeLabel is DEPRECATED and labeling persistent volumes has been taken over by [cloud controller manager](/docs/tasks/administer-cluster/running-cloud-controller/). +a different zone. PersistentVolumeLabel is DEPRECATED and labeling persistent volumes has been taken over by +[cloud controller manager](/docs/tasks/administer-cluster/running-cloud-controller/). +Starting from 1.11, this admission controller is disabled by default. ### PodNodeSelector @@ -468,7 +461,6 @@ metadata: #### Internal Behavior This admission controller has the following behavior: - 1. If the `Namespace` has an annotation with a key `scheduler.alpha.kubernetes.io/node-selector`, use its value as the node selector. 1. If the namespace lacks such an annotation, use the `clusterDefaultNodeSelector` defined in the `PodNodeSelector` @@ -564,15 +556,15 @@ See the [resourceQuota design doc](https://git.k8s.io/community/contributors/des ### SecurityContextDeny -This admission controller will deny any pod that attempts to set certain escalating [SecurityContext](/docs/tasks/configure-pod-container/security-context/) fields. This should be enabled if a cluster doesn't utilize [pod security policies](/docs/concepts/policy/pod-security-policy/) to restrict the set of values a security context can take. +This admission controller will deny any pod that attempts to set certain escalating [SecurityContext](/docs/user-guide/security-context) fields. This should be enabled if a cluster doesn't utilize [pod security policies](/docs/user-guide/pod-security-policy) to restrict the set of values a security context can take. ### ServiceAccount -This admission controller implements automation for [serviceAccounts](/docs/tasks/configure-pod-container/configure-service-account/). +This admission controller implements automation for [serviceAccounts](/docs/user-guide/service-accounts). We strongly recommend using this admission controller if you intend to make use of Kubernetes `ServiceAccount` objects. -### Storage Object in Use Protection (beta) -{{< feature-state for_k8s_version="v1.10" state="beta" >}} +### Storage Object in Use Protection + The `StorageObjectInUseProtection` plugin adds the `kubernetes.io/pvc-protection` or `kubernetes.io/pv-protection` finalizers to newly created Persistent Volume Claims (PVCs) or Persistent Volumes (PV). In case a user deletes a PVC or PV the PVC or PV is not removed until the finalizer is removed from the PVC or PV by PVC or PV Protection Controller. Refer to the [Storage Object in Use Protection](/docs/concepts/storage/persistent-volumes/#storage-object-in-use-protection) for more detailed information. ### ValidatingAdmissionWebhook (alpha in 1.8; beta in 1.9) diff --git a/content/en/docs/reference/access-authn-authz/authentication.md b/content/en/docs/reference/access-authn-authz/authentication.md index 296fd4d3a66a0..34bbb3c4b5e4c 100644 --- a/content/en/docs/reference/access-authn-authz/authentication.md +++ b/content/en/docs/reference/access-authn-authz/authentication.md @@ -664,7 +664,7 @@ rules: ## client-go credential plugins -{{< feature-state for_k8s_version="v1.10" state="alpha" >}} +{% assign for_k8s_version="v1.11" %}{% include feature-state-beta.md %} `k8s.io/client-go` and tools using it such as `kubectl` and `kubelet` are able to execute an external command to receive user credentials. @@ -675,8 +675,6 @@ protocol specific logic, then returns opaque credentials to use. Almost all cred use cases require a server side component with support for the [webhook token authenticator](#webhook-token-authentication) to interpret the credential format produced by the client plugin. -As of 1.10 only bearer tokens are supported. Support for client certs may be added in a future release. - ### Example use case In a hypothetical use case, an organization would run an external service that exchanges LDAP credentials @@ -707,11 +705,13 @@ users: # Command to execute. Required. command: "example-client-go-exec-plugin" - # API version to use when encoding and decoding the ExecCredentials - # resource. Required. + # API version to use when decoding the ExecCredentials resource. Required. + # + # The API version returned by the plugin MUST match the version listed here. # - # The API version returned by the plugin MUST match the version encoded. - apiVersion: "client.authentication.k8s.io/v1alpha1" + # To integrate with tools that support multiple versions (such as client.authentication.k8s.io/v1alpha1), + # set an environment variable or pass an argument to the tool that indicates which version the exec plugin expects. + apiVersion: "client.authentication.k8s.io/v1beta1" # Environment variables to set when executing the plugin. Optional. env: @@ -745,72 +745,61 @@ the binary `/home/jane/bin/example-client-go-exec-plugin` is executed. exec: # Path relative to the directory of the kubeconfig command: "./bin/example-client-go-exec-plugin" - apiVersion: "client.authentication.k8s.io/v1alpha1" + apiVersion: "client.authentication.k8s.io/v1beta1" ``` ### Input and output formats -When executing the command, `k8s.io/client-go` sets the `KUBERNETES_EXEC_INFO` environment -variable to a JSON serialized [`ExecCredential`]( -https://github.com/kubernetes/client-go/blob/master/pkg/apis/clientauthentication/v1alpha1/types.go) -resource. - -``` -KUBERNETES_EXEC_INFO='{ - "apiVersion": "client.authentication.k8s.io/v1alpha1", - "kind": "ExecCredential", - "spec": { - "interactive": true - } -}' -``` +The executed command prints an `ExecCredential` object to `stdout`. `k8s.io/client-go` +authenticates against the Kubernetes API using the returned credentials in the `status`. -When plugins are executed from an interactive session, `stdin` and `stderr` are directly -exposed to the plugin so it can prompt the user for input for interactive logins. +When run from an interactive session, `stdin` is exposed directly to the plugin. Plugins should use a +[TTY check](https://godoc.org/golang.org/x/crypto/ssh/terminal#IsTerminal) to determine if it's +appropriate to prompt a user interactively. -When responding to a 401 HTTP status code (indicating invalid credentials), this object will -include metadata about the response. +To use bearer token credentials, the plugin returns a token in the status of the `ExecCredential`. ```json { - "apiVersion": "client.authentication.k8s.io/v1alpha1", + "apiVersion": "client.authentication.k8s.io/v1beta1", "kind": "ExecCredential", - "spec": { - "response": { - "code": 401, - "header": { - "WWW-Authenticate": [ - "Bearer realm=ldap.example.com" - ] - }, - }, - "interactive": true + "status": { + "token": "my-bearer-token" } } ``` -The executed command is expected to print an `ExecCredential` to `stdout`. `k8s.io/client-go` -will then use the returned bearer token in the `status` when authenticating against the -Kubernetes API. +Alternatively, a PEM-encoded client certificate and key can be returned to use TLS client auth. +If the plugin returns a different certificate and key on a subsequent call, `k8s.io/client-go` +will close existing connections with the server to force a new TLS handshake. + +If specified, `clientKeyData` and `clientCertificateData` must both must be present. + +`clientCertificateData` may contain additional intermediate certificates to send to the server. ```json { - "apiVersion": "client.authentication.k8s.io/v1alpha1", + "apiVersion": "client.authentication.k8s.io/v1beta1", "kind": "ExecCredential", "status": { - "token": "my-bearer-token" + "clientCertificateData": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "clientKeyData": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----" } } ``` -Optionally, this output can include the expiry of the token formatted as a RFC3339 timestamp. -If an expiry is omitted, the bearer token is cached until the server responds with a 401 HTTP -status code. Note that this caching is only for the duration of process and therefore the plugin -is triggered each time the tool using the plugin is invoked. +Optionally, the response can include the expiry of the credential formatted as a +RFC3339 timestamp. Presence or absence of an expiry has the following impact: + +- If an expiry is included, the bearer token and TLS credentials are cached until + the expiry time is reached, or if the server responds with a 401 HTTP status code, + or when the process exits. +- If an expiry is omitted, the bearer token and TLS credentials are cached until + the server responds with a 401 HTTP status code or until the process exits. ```json { - "apiVersion": "client.authentication.k8s.io/v1alpha1", + "apiVersion": "client.authentication.k8s.io/v1beta1", "kind": "ExecCredential", "status": { "token": "my-bearer-token", diff --git a/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md b/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md index 8c7aeb6e42c71..fd7e36d8233f3 100644 --- a/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md +++ b/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md @@ -1,13 +1,13 @@ --- title: cloud-controller-manager notitle: true -weight: 90 --- - ## cloud-controller-manager + ### Synopsis + The Cloud controller manager is a daemon that embeds the cloud specific control loops shipped with Kubernetes. @@ -17,263 +17,309 @@ cloud-controller-manager [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--address ip     Default: 0.0.0.0
DEPRECATED: the IP address on which to listen for the --port port. See --bind-address instead.DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See --bind-address instead.
--allocate-node-cidrs
Should CIDRs for Pods be allocated and set on the cloud provider.Should CIDRs for Pods be allocated and set on the cloud provider.
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--bind-address ip     Default: 0.0.0.0
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--cert-dir string     Default: "/var/run/kubernetes"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--cidr-allocator-type string     Default: "RangeAllocator"
Type of CIDR allocator to useType of CIDR allocator to use
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider of cloud services. Cannot be empty.The provider for cloud services. Empty string for no provider.
--cluster-cidr string
CIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be trueCIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be true
--cluster-name string     Default: "kubernetes"
The instance prefix for the cluster.The instance prefix for the cluster.
--concurrent-service-syncs int32     Default: 1
The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) loadThe number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load
--configure-cloud-routes     Default: true
Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.
--contention-profiling
Enable lock contention profiling, if profiling is enabled.Enable lock contention profiling, if profiling is enabled
--controller-start-interval duration
Interval between starting controller managers.Interval between starting controller managers.
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
-h, --help
help for cloud-controller-managerhelp for cloud-controller-manager
--http2-max-streams-per-connection int
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.
--kube-api-burst int32     Default: 30
Burst to use while talking with kubernetes apiserver.Burst to use while talking with kubernetes apiserver.
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.Content type of requests sent to apiserver.
--kube-api-qps float32     Default: 20
QPS to use while talking with kubernetes apiserver.QPS to use while talking with kubernetes apiserver.
--kubeconfig string
Path to kubeconfig file with authorization and master location information.Path to kubeconfig file with authorization and master location information.
--leader-elect     Default: true
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.
--leader-elect-lease-duration duration     Default: 15s
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.
--leader-elect-renew-deadline duration     Default: 10s
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.
--leader-elect-resource-lock endpoints     Default: "endpoints"
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-retry-period duration     Default: 2s
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig).The address of the Kubernetes API server (overrides any value in kubeconfig).
--min-resync-period duration     Default: 12h0m0s
The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.
--node-monitor-period duration     Default: 5s
The period for syncing NodeStatus in NodeController.The period for syncing NodeStatus in NodeController.
--node-status-update-frequency duration     Default: 5m0s
Specifies how often the controller updates nodes' status.Specifies how often the controller updates nodes' status.
--port int     Default: 10253
DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.
--profiling     Default: true--profiling
Enable profiling via web interface host:port/debug/pprof/Enable profiling via web interface host:port/debug/pprof/
--route-reconciliation-period duration     Default: 10s
The period for reconciling routes created for Nodes by cloud provider.The period for reconciling routes created for Nodes by cloud provider.
--secure-port int
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--tls-cert-file string
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If omitted, the default Go cipher suites will be usedComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be use. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
--tls-min-version string
Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants.Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12
--tls-private-key-file string
File containing the default x509 private key matching --tls-cert-file.File containing the default x509 private key matching --tls-cert-file.
--tls-sni-cert-key namedCertKey     Default: []
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".
--use-service-account-credentials
If true, use individual service account credentials for each controller.If true, use individual service account credentials for each controller.
--version version[=true]
Print version information and quitPrint version information and quit
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index a12ad8c14315c..32c140cc53d95 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -38,7 +38,9 @@ different Kubernetes components. | `BlockVolume` | `false` | Alpha | 1.9 | | | `CPUManager` | `false` | Alpha | 1.8 | 1.9 | | `CPUManager` | `true` | Beta | 1.10 | | -| `CRIContainerLogRotation` | `false` | Alpha | 1.10 | | +| `CRIContainerLogRotation` | `false` | Alpha | 1.10 | 1.10 | +| `CRIContainerLogRotation` | `true` | Beta| 1.11 | | +| `CSIBlockVolume` | `false` | Alpha | 1.11 | 1.11 | | `CSIPersistentVolume` | `false` | Alpha | 1.9 | 1.9 | | `CSIPersistentVolume` | `true` | Beta | 1.10 | | | `CustomPodDNS` | `false` | Alpha | 1.9 | 1.9 | @@ -49,11 +51,13 @@ different Kubernetes components. | `DebugContainers` | `false` | Alpha | 1.10 | | | `DevicePlugins` | `false` | Alpha | 1.8 | 1.9 | | `DevicePlugins` | `true` | Beta | 1.10 | | -| `DynamicKubeletConfig` | `false` | Alpha | 1.4 | | +| `DynamicKubeletConfig` | `false` | Alpha | 1.4 | 1.10 | +| `DynamicKubeletConfig` | `true` | Beta | 1.11 | | | `DynamicVolumeProvisioning` | `true` | Alpha | 1.3 | 1.7 | | `DynamicVolumeProvisioning` | `true` | GA | 1.8 | | | `EnableEquivalenceClassCache` | `false` | Alpha | 1.8 | | -| `ExpandPersistentVolumes` | `false` | Alpha | 1.8 | 1.8 | +| `ExpandPersistentVolumes` | `false` | Alpha | 1.8 | 1.10 | +| `ExpandPersistentVolumes` | `true` | Beta | 1.11 | | | `ExperimentalCriticalPodAnnotation` | `false` | Alpha | 1.5 | | | `ExperimentalHostUserNamespaceDefaulting` | `false` | Beta | 1.5 | | | `GCERegionalPersistentDisk` | `true` | Beta | 1.10 | | @@ -77,19 +81,23 @@ different Kubernetes components. | `RotateKubeletClientCertificate` | `true` | Beta | 1.7 | | | `RotateKubeletServerCertificate` | `false` | Alpha | 1.7 | | | `RunAsGroup` | `false` | Alpha | 1.10 | | -| `ScheduleDaemonSetPods` | `false` | Alpha | 1.10 | | | `ServiceNodeExclusion` | `false` | Alpha | 1.8 | | -| `StorageObjectInUseProtection` | `true` | Beta | 1.10 | | +| `StorageObjectInUseProtection` | `true` | Beta | 1.10 | 1.10 | +| `StorageObjectInUseProtection` | `true` | GA | 1.11 | | | `StreamingProxyRedirects` | `true` | Beta | 1.5 | | | `SupportIPVSProxyMode` | `false` | Alpha | 1.8 | 1.8 | | `SupportIPVSProxyMode` | `false` | Beta | 1.9 | 1.9 | -| `SupportIPVSProxyMode` | `true` | Beta | 1.10 | | +| `SupportIPVSProxyMode` | `true` | Beta | 1.10 | 1.10 | +| `SupportIPVSProxyMode` | `true` | GA | 1.11 | | | `SupportPodPidsLimit` | `false` | Alpha | 1.10 | | +| `Sysctls` | `true` | Beta | 1.11 | | | `TaintBasedEvictions` | `false` | Alpha | 1.6 | | | `TaintNodesByCondition` | `false` | Alpha | 1.8 | | | `TokenRequest` | `false` | Alpha | 1.10 | | | `VolumeScheduling` | `false` | Alpha | 1.9 | 1.9 | | `VolumeScheduling` | `true` | Beta | 1.10 | | +| `VolumeSubpathEnvExpansion` | `false` | Alpha | 1.11 | | +| `ScheduleDaemonSetPods` | `false` | Alpha | 1.11 | | ## Using a Feature @@ -146,6 +154,7 @@ Each feature gate is designed for enabling/disabling a specific feature: for more details. - `CPUManager`: Enable container level CPU affinity support, see [CPU Management Policies](/docs/tasks/administer-cluster/cpu-management-policies/). - `CRIContainerLogRotation`: Enable container log rotation for cri container runtime. +- `CSIBlockVolume`: Enable external CSI volume drivers to support block storage. See the [`csi` raw block volume support](/docs/concepts/storage/volumes/#csi-raw-block-volume-support) documentation for more details. - `CSIPersistentVolume`: Enable discovering and mounting volumes provisioned through a [CSI (Container Storage Interface)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md) compatible volume plugin. @@ -211,6 +220,8 @@ Each feature gate is designed for enabling/disabling a specific feature: - `SupportIPVSProxyMode`: Enable providing in-cluster service load balancing using IPVS. See [service proxies](/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies) for more details. - `SupportPodPidsLimit`: Enable the support to limiting PIDs in Pods. +- `Sysctls`: Enable support for namespaced kernel parameters (sysctls) that can be set for each pod. + See [sysctls](/docs/tasks/administer-cluster/sysctl-cluster/) for more details. - `TaintBasedEvictions`: Enable evicting pods from nodes based on taints on nodes and tolerations on Pods. See [taints and tolerations](/docs/concepts/configuration/taint-and-toleration/) for more details. - `TaintNodesByCondition`: Enable automatic tainting nodes based on [node conditions](/docs/concepts/architecture/nodes/#condition). @@ -219,4 +230,3 @@ Each feature gate is designed for enabling/disabling a specific feature: PersistentVolumeClaim (PVC) binding aware of scheduling decisions. It also enables the usage of [`local`](/docs/concepts/storage/volumes/#local) volume type when used together with the `PersistentLocalVolumes` feature gate. - diff --git a/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md b/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md index 0817c4e4b98d8..2a9f0ce66b0c8 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md @@ -1,12 +1,14 @@ --- title: kube-apiserver notitle: true -weight: 40 --- ## kube-apiserver + + ### Synopsis + The Kubernetes API server validates and configures data for the api objects which include pods, services, replicationcontrollers, and others. The API Server services REST operations and provides the frontend to the @@ -18,745 +20,925 @@ kube-apiserver [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + - + + - + + - + + - + + - + + - - - - - - - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--admission-control-config-file string
File with admission control configuration.File with admission control configuration.
--advertise-address ip
The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
--allow-privileged
If true, allow privileged containers. [default=false]If true, allow privileged containers. [default=false]
--anonymous-auth     Default: true
Enables anonymous requests to the secure port of the API server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.Enables anonymous requests to the secure port of the API server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.
--apiserver-count int     Default: 1
The number of apiservers running in the cluster, must be a positive number.The number of apiservers running in the cluster, must be a positive number. (In use when --endpoint-reconciler-type=master-count is enabled.)
--audit-log-batch-buffer-size int     Default: 10000
The size of the buffer to store events before batching and writing. Only used in batch mode.The size of the buffer to store events before batching and writing. Only used in batch mode.
--audit-log-batch-max-size int     Default: 400
The maximum size of a batch. Only used in batch mode.The maximum size of a batch. Only used in batch mode.
--audit-log-batch-max-wait duration     Default: 30s
The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.
--audit-log-batch-throttle-burst int     Default: 15
Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.
--audit-log-batch-throttle-enable
Whether batching throttling is enabled. Only used in batch mode.Whether batching throttling is enabled. Only used in batch mode.
--audit-log-batch-throttle-qps float32     Default: 10
Maximum average number of batches per second. Only used in batch mode.Maximum average number of batches per second. Only used in batch mode.
--audit-log-format string     Default: "json"
Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Requires the 'AdvancedAuditing' feature gate. Known formats are legacy,json.Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Requires the 'AdvancedAuditing' feature gate. Known formats are legacy,json.
--audit-log-maxage int
The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
--audit-log-maxbackup int
The maximum number of old audit log files to retain.The maximum number of old audit log files to retain.
--audit-log-maxsize int
The maximum size in megabytes of the audit log file before it gets rotated.The maximum size in megabytes of the audit log file before it gets rotated.
--audit-log-mode string     Default: "blocking"
Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.
--audit-log-path string
If set, all requests coming to the apiserver will be logged to this file. '-' means standard out.If set, all requests coming to the apiserver will be logged to this file. '-' means standard out.
--audit-log-truncate-enabled
Whether event and batch truncating is enabled.
--audit-log-truncate-max-batch-size int     Default: 10485760
Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size.
--audit-log-truncate-max-event-size int     Default: 102400
Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, andif this doesn't reduce the size enough, event is discarded.
--audit-log-version string     Default: "audit.k8s.io/v1beta1"
API group and version used for serializing audit events written to log.
--audit-policy-file string
Path to the file that defines the audit policy configuration. Requires the 'AdvancedAuditing' feature gate. With AdvancedAuditing, a profile is required to enable auditing.Path to the file that defines the audit policy configuration. Requires the 'AdvancedAuditing' feature gate. With AdvancedAuditing, a profile is required to enable auditing.
--audit-webhook-batch-buffer-size int     Default: 10000
The size of the buffer to store events before batching and writing. Only used in batch mode.The size of the buffer to store events before batching and writing. Only used in batch mode.
--audit-webhook-batch-max-size int     Default: 400
The maximum size of a batch. Only used in batch mode.The maximum size of a batch. Only used in batch mode.
--audit-webhook-batch-max-wait duration     Default: 30s
The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.
--audit-webhook-batch-throttle-burst int     Default: 15
Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.
--audit-webhook-batch-throttle-enable     Default: true
Whether batching throttling is enabled. Only used in batch mode.Whether batching throttling is enabled. Only used in batch mode.
--audit-webhook-batch-throttle-qps float32     Default: 10
Maximum average number of batches per second. Only used in batch mode.Maximum average number of batches per second. Only used in batch mode.
--audit-webhook-config-file string
Path to a kubeconfig formatted file that defines the audit webhook configuration. Requires the 'AdvancedAuditing' feature gate.Path to a kubeconfig formatted file that defines the audit webhook configuration. Requires the 'AdvancedAuditing' feature gate.
--audit-webhook-initial-backoff duration     Default: 10s
The amount of time to wait before retrying the first failed request.The amount of time to wait before retrying the first failed request.
--audit-webhook-mode string     Default: "batch"
Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.
--audit-webhook-truncate-enabled
Whether event and batch truncating is enabled.
--audit-webhook-truncate-max-batch-size int     Default: 10485760
Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size.
--audit-webhook-truncate-max-event-size int     Default: 102400
Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, andif this doesn't reduce the size enough, event is discarded.
--audit-webhook-version string     Default: "audit.k8s.io/v1beta1"
API group and version used for serializing audit events written to webhook.
--authentication-token-webhook-cache-ttl duration     Default: 2m0s
The duration to cache responses from the webhook token authenticator.The duration to cache responses from the webhook token authenticator.
--authentication-token-webhook-config-file string
File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.
--authorization-mode string     Default: "AlwaysAllow"--authorization-mode stringSlice     Default: [AlwaysAllow]
Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node.Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node.
--authorization-policy-file string
File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port.File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port.
--authorization-webhook-cache-authorized-ttl duration     Default: 5m0s
The duration to cache 'authorized' responses from the webhook authorizer.The duration to cache 'authorized' responses from the webhook authorizer.
--authorization-webhook-cache-unauthorized-ttl duration     Default: 30s
The duration to cache 'unauthorized' responses from the webhook authorizer.The duration to cache 'unauthorized' responses from the webhook authorizer.
--authorization-webhook-config-file string
File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port.File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port.
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--basic-auth-file string
If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
--bind-address ip     Default: 0.0.0.0
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--cert-dir string     Default: "/var/run/kubernetes"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--client-ca-file string
If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider for cloud services. Empty string for no provider.The provider for cloud services. Empty string for no provider.
--contention-profiling
Enable lock contention profiling, if profiling is enabledEnable lock contention profiling, if profiling is enabled
--cors-allowed-origins stringSlice
List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
--default-watch-cache-size int     Default: 100
Default watch cache size. If zero, watch cache will be disabled for resources that do not have a default watch size set.Default watch cache size. If zero, watch cache will be disabled for resources that do not have a default watch size set.
--delete-collection-workers int     Default: 1
Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup.Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup.
--deserialization-cache-size int
Number of deserialized json objects to cache in memory.Number of deserialized json objects to cache in memory.
--disable-admission-plugins stringSlice
admission plugins that should be disabled although they are in the default enabled plugins list. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, InitialResources, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.admission plugins that should be disabled although they are in the default enabled plugins list. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.
--enable-admission-plugins stringSlice
admission plugins that should be enabled in addition to default enabled ones. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, InitialResources, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.admission plugins that should be enabled in addition to default enabled ones. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.
--enable-aggregator-routing
Turns on aggregator routing requests to endoints IP rather than cluster IP.Turns on aggregator routing requests to endoints IP rather than cluster IP.
--enable-bootstrap-token-auth
Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication.Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication.
--enable-garbage-collector     Default: true
Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.
--enable-logs-handler     Default: true
If true, install a /logs handler for the apiserver logs.If true, install a /logs handler for the apiserver logs.
--enable-swagger-ui
Enables swagger ui on the apiserver at /swagger-uiEnables swagger ui on the apiserver at /swagger-ui
--endpoint-reconciler-type string     Default: "master-count"--endpoint-reconciler-type string     Default: "lease"
Use an endpoint reconciler (master-count, lease, none)Use an endpoint reconciler (master-count, lease, none)
--etcd-cafile string
SSL Certificate Authority file used to secure etcd communication.SSL Certificate Authority file used to secure etcd communication.
--etcd-certfile string
SSL certification file used to secure etcd communication.SSL certification file used to secure etcd communication.
--etcd-compaction-interval duration     Default: 5m0s
The interval of compaction requests. If 0, the compaction request from apiserver is disabled.The interval of compaction requests. If 0, the compaction request from apiserver is disabled.
--etcd-count-metric-poll-period duration     Default: 1m0s
Frequency of polling etcd for number of resources per type. 0 disables the metric collection.Frequency of polling etcd for number of resources per type. 0 disables the metric collection.
--etcd-keyfile string
SSL key file used to secure etcd communication.SSL key file used to secure etcd communication.
--etcd-prefix string     Default: "/registry"
The prefix to prepend to all resource paths in etcd.The prefix to prepend to all resource paths in etcd.
--etcd-servers stringSlice
List of etcd servers to connect with (scheme://ip:port), comma separated.List of etcd servers to connect with (scheme://ip:port), comma separated.
--etcd-servers-overrides stringSlice
Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated.Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are URLs, semicolon separated.
--event-ttl duration     Default: 1h0m0s
Amount of time to retain events.Amount of time to retain events.
--experimental-encryption-provider-config string
The file containing configuration for encryption providers to be used for storing secrets in etcdThe file containing configuration for encryption providers to be used for storing secrets in etcd
--external-hostname string
The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
-h, --help
help for kube-apiserverhelp for kube-apiserver
--http2-max-streams-per-connection int
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.
--kubelet-certificate-authority string
Path to a cert file for the certificate authority.Path to a cert file for the certificate authority.
--kubelet-client-certificate string
Path to a client cert file for TLS.Path to a client cert file for TLS.
--kubelet-client-key string
Path to a client key file for TLS.Path to a client key file for TLS.
--kubelet-https     Default: true
Use https for kubelet connections.Use https for kubelet connections.
--kubelet-preferred-address-types stringSlice     Default: [Hostname,InternalDNS,InternalIP,ExternalDNS,ExternalIP]
List of the preferred NodeAddressTypes to use for kubelet connections.List of the preferred NodeAddressTypes to use for kubelet connections.
--kubelet-read-only-port uint     Default: 10255
DEPRECATED: kubelet port.DEPRECATED: kubelet port.
--kubelet-timeout duration     Default: 5s
Timeout for kubelet operations.Timeout for kubelet operations.
--kubernetes-service-node-port int
If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master-service-namespace string     Default: "default"
DEPRECATED: the namespace from which the kubernetes master services should be injected into pods.DEPRECATED: the namespace from which the kubernetes master services should be injected into pods.
--max-connection-bytes-per-sec int
If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.
--max-mutating-requests-inflight int     Default: 200
The maximum number of mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.The maximum number of mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.
--max-requests-inflight int     Default: 400
The maximum number of non-mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.The maximum number of non-mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.
--min-request-timeout int     Default: 1800
An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.
--oidc-ca-file string
If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used.If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used.
--oidc-client-id string
The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
--oidc-groups-claim string
If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.
--oidc-groups-prefix string
If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.
--oidc-issuer-url string
The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).
--oidc-required-claim mapStringString
A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
--oidc-signing-algs stringSlice     Default: [RS256]
Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1.Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1.
--oidc-username-claim string     Default: "sub"
The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details.The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details.
--oidc-username-prefix string
If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'.If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'.
--profiling     Default: true
Enable profiling via web interface host:port/debug/pprof/Enable profiling via web interface host:port/debug/pprof/
--proxy-client-cert-file string
Client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins. It is expected that this cert includes a signature from the CA in the --requestheader-client-ca-file flag. That CA is published in the 'extension-apiserver-authentication' configmap in the kube-system namespace. Components receiving calls from kube-aggregator should use that CA to perform their half of the mutual TLS verification.Client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins. It is expected that this cert includes a signature from the CA in the --requestheader-client-ca-file flag. That CA is published in the 'extension-apiserver-authentication' configmap in the kube-system namespace. Components receiving calls from kube-aggregator should use that CA to perform their half of the mutual TLS verification.
--proxy-client-key-file string
Private key for the client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins.
--repair-malformed-updates     Default: true
If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates.Private key for the client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins.
--request-timeout duration     Default: 1m0s
An optional field indicating the duration a handler must keep a request open before timing it out. This is the default request timeout for requests but may be overridden by flags such as --min-request-timeout for specific types of requests.An optional field indicating the duration a handler must keep a request open before timing it out. This is the default request timeout for requests but may be overridden by flags such as --min-request-timeout for specific types of requests.
--requestheader-allowed-names stringSlice
List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed.List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed.
--requestheader-client-ca-file string
Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headersRoot certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers. WARNING: generally do not depend on authorization being already done for incoming requests.
--requestheader-extra-headers-prefix stringSlice
List of request header prefixes to inspect. X-Remote-Extra- is suggested.List of request header prefixes to inspect. X-Remote-Extra- is suggested.
--requestheader-group-headers stringSlice
List of request headers to inspect for groups. X-Remote-Group is suggested.List of request headers to inspect for groups. X-Remote-Group is suggested.
--requestheader-username-headers stringSlice
List of request headers to inspect for usernames. X-Remote-User is common.List of request headers to inspect for usernames. X-Remote-User is common.
--runtime-config mapStringString
A set of key=value pairs that describe runtime configuration that may be passed to apiserver. <group>/<version> (or <version> for the core group) key can be used to turn on/off specific api versions. <group>/<version>/<resource> (or <version>/<resource> for the core group) can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.A set of key=value pairs that describe runtime configuration that may be passed to apiserver. <group>/<version> (or <version> for the core group) key can be used to turn on/off specific api versions. api/all is special key to control all api versions, be careful setting it false, unless you know what you do. api/legacy is deprecated, we will remove it in the future, so stop using it.
--secure-port int     Default: 6443
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--service-account-api-audiences stringSlice
Identifiers of the API. The service account token authenticator will validate that tokens used against the API are bound to at least one of these audiences.Identifiers of the API. The service account token authenticator will validate that tokens used against the API are bound to at least one of these audiences.
--service-account-issuer string
Identifier of the service account token issuer. The issuer will assert this identifier in "iss" claim of issued tokens. This value is a string or URI.Identifier of the service account token issuer. The issuer will assert this identifier in "iss" claim of issued tokens. This value is a string or URI.
--service-account-key-file stringArray
File containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. The specified file can contain multiple keys, and the flag can be specified multiple times with different files. If unspecified, --tls-private-key-file is used. Must be specified when --service-account-signing-key is providedFile containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. The specified file can contain multiple keys, and the flag can be specified multiple times with different files. If unspecified, --tls-private-key-file is used. Must be specified when --service-account-signing-key is provided
--service-account-lookup     Default: true
If true, validate ServiceAccount tokens exist in etcd as part of authentication.If true, validate ServiceAccount tokens exist in etcd as part of authentication.
--service-account-signing-key-file string
Path to the file that contains the current private key of the service account token issuer. The issuer will sign issued ID tokens with this private key. (Ignored unless alpha TokenRequest is enabledPath to the file that contains the current private key of the service account token issuer. The issuer will sign issued ID tokens with this private key. (Requires the 'TokenRequest' feature gate.)
--service-cluster-ip-range ipNet     Default: 10.0.0.0/24
A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
--service-node-port-range portRange     Default: 30000-32767
A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range.A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range.
--storage-backend string
The storage backend for persistence. Options: 'etcd3' (default), 'etcd2'.The storage backend for persistence. Options: 'etcd3' (default), 'etcd2'.
--storage-media-type string     Default: "application/vnd.kubernetes.protobuf"
The media type to use to store objects in storage. Some resources or storage backends may only support a specific media type and will ignore this setting.The media type to use to store objects in storage. Some resources or storage backends may only support a specific media type and will ignore this setting.
--storage-versions string     Default: "admission.k8s.io/v1beta1,
admissionregistration.k8s.io/v1beta1,
apps/v1,
authentication.k8s.io/v1,
authorization.k8s.io/v1,
autoscaling/v1,
batch/v1,
certificates.k8s.io/v1beta1,
componentconfig/v1alpha1,
events.k8s.io/v1beta1,
extensions/v1beta1,
imagepolicy.k8s.io/v1alpha1,
kubeadm.k8s.io/v1alpha1,
networking.k8s.io/v1,
policy/v1beta1,
rbac.authorization.k8s.io/v1,
scheduling.k8s.io/v1alpha1,
settings.k8s.io/v1alpha1,
storage.k8s.io/v1,
v1"		--storage-versions string     Default: "admission.k8s.io/v1beta1,
admissionregistration.k8s.io/v1beta1,
apps/v1,
authentication.k8s.io/v1,
authorization.k8s.io/v1,
autoscaling/v1,
batch/v1,
certificates.k8s.io/v1beta1,
componentconfig/v1alpha1,
events.k8s.io/v1beta1,
extensions/v1beta1,
imagepolicy.k8s.io/v1alpha1,
networking.k8s.io/v1,
policy/v1beta1,
rbac.authorization.k8s.io/v1,
scheduling.k8s.io/v1beta1,
settings.k8s.io/v1alpha1,
storage.k8s.io/v1,
v1"
The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable.The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all known groups.
--target-ram-mb int
Memory limit for apiserver in MB (used to configure sizes of caches, etc.)Memory limit for apiserver in MB (used to configure sizes of caches, etc.)
--tls-cert-file string
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If omitted, the default Go cipher suites will be usedComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be use. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
--tls-min-version string
Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants.Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12
--tls-private-key-file string
File containing the default x509 private key matching --tls-cert-file.File containing the default x509 private key matching --tls-cert-file.
--tls-sni-cert-key namedCertKey     Default: []
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".
--token-auth-file string
If set, the file that will be used to secure the secure port of the API server via token authentication.If set, the file that will be used to secure the secure port of the API server via token authentication.
--version version[=true]
Print version information and quitPrint version information and quit
--watch-cache     Default: true
Enable watch caching in the apiserverEnable watch caching in the apiserver
--watch-cache-sizes stringSlice
List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource[.group]#size, where resource is lowercase plural (no version), group is optional, and size is a number. It takes effect when watch-cache is enabled. Some resources (replicationcontrollers, endpoints, nodes, pods, services, apiservices.apiregistration.k8s.io) have system defaults set by heuristics, others default to default-watch-cache-sizeList of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource[.group]#size, where resource is lowercase plural (no version), group is optional, and size is a number. It takes effect when watch-cache is enabled. Some resources (replicationcontrollers, endpoints, nodes, pods, services, apiservices.apiregistration.k8s.io) have system defaults set by heuristics, others default to default-watch-cache-size
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md b/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md index f0ff07cbf0d8d..be3aa7a122f7f 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md @@ -1,12 +1,14 @@ --- title: kube-controller-manager notitle: true -weight: 50 --- ## kube-controller-manager + + ### Synopsis + The Kubernetes controller manager is a daemon that embeds the core control loops shipped with Kubernetes. In applications of robotics and automation, a control loop is a non-terminating loop that regulates the state of @@ -22,545 +24,631 @@ kube-controller-manager [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - - - - - - - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--address ip     Default: 0.0.0.0
DEPRECATED: the IP address on which to listen for the --port port. See --bind-address instead.DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See --bind-address instead.
--allocate-node-cidrs
Should CIDRs for Pods be allocated and set on the cloud provider.Should CIDRs for Pods be allocated and set on the cloud provider.
--attach-detach-reconcile-sync-period duration     Default: 1m0s
The reconciler sync wait time between volume attach detach. This duration must be larger than one second, and increasing this value from the default may allow for volumes to be mismatched with pods.The reconciler sync wait time between volume attach detach. This duration must be larger than one second, and increasing this value from the default may allow for volumes to be mismatched with pods.
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--bind-address ip     Default: 0.0.0.0
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--cert-dir string     Default: "/var/run/kubernetes"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--cidr-allocator-type string     Default: "RangeAllocator"
Type of CIDR allocator to useType of CIDR allocator to use
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider for cloud services. Empty string for no provider.The provider for cloud services. Empty string for no provider.
--cluster-cidr string
CIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be trueCIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be true
--cluster-name string     Default: "kubernetes"
The instance prefix for the cluster.The instance prefix for the cluster.
--cluster-signing-cert-file string     Default: "/etc/kubernetes/ca/ca.pem"
Filename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificatesFilename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificates
--cluster-signing-key-file string     Default: "/etc/kubernetes/ca/ca.key"
Filename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificatesFilename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificates
--concurrent-deployment-syncs int32     Default: 5
The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) loadThe number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load
--concurrent-endpoint-syncs int32     Default: 5
The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) loadThe number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load
--concurrent-gc-syncs int32     Default: 20
The number of garbage collector workers that are allowed to sync concurrently.The number of garbage collector workers that are allowed to sync concurrently.
--concurrent-namespace-syncs int32     Default: 10
The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) loadThe number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load
--concurrent-replicaset-syncs int32     Default: 5
The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) loadThe number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load
--concurrent-resource-quota-syncs int32     Default: 5
The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) loadThe number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load
--concurrent-service-syncs int32     Default: 1
The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) loadThe number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load
--concurrent-serviceaccount-token-syncs int32     Default: 5
The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) loadThe number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load
--concurrent_rc_syncs int32     Default: 5
The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) loadThe number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load
--configure-cloud-routes     Default: true
Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.
--contention-profiling
Enable lock contention profiling, if profiling is enabled.Enable lock contention profiling, if profiling is enabled
--controller-start-interval duration
Interval between starting controller managers.Interval between starting controller managers.
--controllers stringSlice     Default: [*]
A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.
All controllers: attachdetach, bootstrapsigner, clusterrole-aggregation, cronjob, csrapproving, csrcleaner, csrsigning, daemonset, deployment, disruption, endpoint, garbagecollector, horizontalpodautoscaling, job, namespace, nodeipam, nodelifecycle, persistentvolume-binder, persistentvolume-expander, podgc, pv-protection, pvc-protection, replicaset, replicationcontroller, resourcequota, route, service, serviceaccount, serviceaccount-token, statefulset, tokencleaner, ttl
Disabled-by-default controllers: bootstrapsigner, tokencleaner		A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.
All controllers: attachdetach, bootstrapsigner, clusterrole-aggregation, cronjob, csrapproving, csrcleaner, csrsigning, daemonset, deployment, disruption, endpoint, garbagecollector, horizontalpodautoscaling, job, namespace, nodeipam, nodelifecycle, persistentvolume-binder, persistentvolume-expander, podgc, pv-protection, pvc-protection, replicaset, replicationcontroller, resourcequota, route, service, serviceaccount, serviceaccount-token, statefulset, tokencleaner, ttl
Disabled-by-default controllers: bootstrapsigner, tokencleaner
--deployment-controller-sync-period duration     Default: 30s
Period for syncing the deployments.Period for syncing the deployments.
--disable-attach-detach-reconcile-sync
Disable volume attach detach reconciler sync. Disabling this may cause volumes to be mismatched with pods. Use wisely.Disable volume attach detach reconciler sync. Disabling this may cause volumes to be mismatched with pods. Use wisely.
--enable-dynamic-provisioning     Default: true
Enable dynamic provisioning for environments that support it.Enable dynamic provisioning for environments that support it.
--enable-garbage-collector     Default: true
Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver.Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver.
--enable-hostpath-provisioner
Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development.Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development.
--enable-taint-manager     Default: true
WARNING: Beta feature. If set to true enables NoExecute Taints and will evict all not-tolerating Pod running on Nodes tainted with this kind of Taints.WARNING: Beta feature. If set to true enables NoExecute Taints and will evict all not-tolerating Pod running on Nodes tainted with this kind of Taints.
--experimental-cluster-signing-duration duration     Default: 8760h0m0s
The length of duration signed certificates will be given.The length of duration signed certificates will be given.
--external-cloud-volume-plugin string
The plugin to use when cloud provider is set to external. Can be empty, should only be set when cloud-provider is external. Currently used to allow node and volume controllers to work for in tree cloud providers.The plugin to use when cloud provider is set to external. Can be empty, should only be set when cloud-provider is external. Currently used to allow node and volume controllers to work for in tree cloud providers.
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
--flex-volume-plugin-dir string     Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"
Full path of the directory in which the flex volume plugin should search for additional third party volume plugins.Full path of the directory in which the flex volume plugin should search for additional third party volume plugins.
-h, --help
help for kube-controller-managerhelp for kube-controller-manager
--horizontal-pod-autoscaler-downscale-delay duration     Default: 5m0s
The period since last downscale, before another downscale can be performed in horizontal pod autoscaler.The period since last downscale, before another downscale can be performed in horizontal pod autoscaler.
--horizontal-pod-autoscaler-sync-period duration     Default: 30s
The period for syncing the number of pods in horizontal pod autoscaler.The period for syncing the number of pods in horizontal pod autoscaler.
--horizontal-pod-autoscaler-tolerance float     Default: 0.1
The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling.The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling.
--horizontal-pod-autoscaler-upscale-delay duration     Default: 3m0s
The period since last upscale, before another upscale can be performed in horizontal pod autoscaler.The period since last upscale, before another upscale can be performed in horizontal pod autoscaler.
--horizontal-pod-autoscaler-use-rest-clients     Default: true
WARNING: alpha feature. If set to true, causes the horizontal pod autoscaler controller to use REST clients through the kube-aggregator, instead of using the legacy metrics client through the API server proxy. This is required for custom metrics support in the horizontal pod autoscaler.If set to true, causes the horizontal pod autoscaler controller to use REST clients through the kube-aggregator, instead of using the legacy metrics client through the API server proxy. This is required for custom metrics support in the horizontal pod autoscaler.
--http2-max-streams-per-connection int
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.
--insecure-experimental-approve-all-kubelet-csrs-for-group string
This flag does nothing.This flag does nothing.
--kube-api-burst int32     Default: 30
Burst to use while talking with kubernetes apiserver.Burst to use while talking with kubernetes apiserver.
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.Content type of requests sent to apiserver.
--kube-api-qps float32     Default: 20
QPS to use while talking with kubernetes apiserver.QPS to use while talking with kubernetes apiserver.
--kubeconfig string
Path to kubeconfig file with authorization and master location information.Path to kubeconfig file with authorization and master location information.
--large-cluster-size-threshold int32     Default: 50
Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller.Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller.
--leader-elect     Default: true
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.
--leader-elect-lease-duration duration     Default: 15s
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.
--leader-elect-renew-deadline duration     Default: 10s
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.
--leader-elect-resource-lock endpoints     Default: "endpoints"
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-retry-period duration     Default: 2s
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig).The address of the Kubernetes API server (overrides any value in kubeconfig).
--min-resync-period duration     Default: 12h0m0s
The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.
--namespace-sync-period duration     Default: 5m0s
The period for syncing namespace life-cycle updatesThe period for syncing namespace life-cycle updates
--node-cidr-mask-size int32     Default: 24
Mask size for node cidr in cluster.Mask size for node cidr in cluster.
--node-eviction-rate float32     Default: 0.1
Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters.Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters.
--node-monitor-grace-period duration     Default: 40s
Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.
--node-monitor-period duration     Default: 5s
The period for syncing NodeStatus in NodeController.The period for syncing NodeStatus in NodeController.
--node-startup-grace-period duration     Default: 1m0s
Amount of time which we allow starting Node to be unresponsive before marking it unhealthy.Amount of time which we allow starting Node to be unresponsive before marking it unhealthy.
--pod-eviction-timeout duration     Default: 5m0s
The grace period for deleting pods on failed nodes.The grace period for deleting pods on failed nodes.
--port int     Default: 10252
DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.
--profiling     Default: true--profiling
Enable profiling via web interface host:port/debug/pprof/Enable profiling via web interface host:port/debug/pprof/
--pv-recycler-increment-timeout-nfs int32     Default: 30
the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber podthe increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod
--pv-recycler-minimum-timeout-hostpath int32     Default: 60
The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster.The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster.
--pv-recycler-minimum-timeout-nfs int32     Default: 300
The minimum ActiveDeadlineSeconds to use for an NFS Recycler podThe minimum ActiveDeadlineSeconds to use for an NFS Recycler pod
--pv-recycler-pod-template-filepath-hostpath string
The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster.The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster.
--pv-recycler-pod-template-filepath-nfs string
The file path to a pod definition used as a template for NFS persistent volume recyclingThe file path to a pod definition used as a template for NFS persistent volume recycling
--pv-recycler-timeout-increment-hostpath int32     Default: 30
the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster.the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster.
--pvclaimbinder-sync-period duration     Default: 15s
The period for syncing persistent volumes and persistent volume claimsThe period for syncing persistent volumes and persistent volume claims
--resource-quota-sync-period duration     Default: 5m0s
The period for syncing quota usage status in the systemThe period for syncing quota usage status in the system
--root-ca-file string
If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.
--route-reconciliation-period duration     Default: 10s
The period for reconciling routes created for Nodes by cloud provider.The period for reconciling routes created for Nodes by cloud provider.
--secondary-node-eviction-rate float32     Default: 0.01
Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold.Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold.
--secure-port int
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--service-account-private-key-file string
Filename containing a PEM-encoded private RSA or ECDSA key used to sign service account tokens.The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--service-cluster-ip-range string
CIDR Range for Services in cluster. Requires --allocate-node-cidrs to be trueCIDR Range for Services in cluster. Requires --allocate-node-cidrs to be true
--terminated-pod-gc-threshold int32     Default: 12500
Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled.Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled.
--tls-cert-file string
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If omitted, the default Go cipher suites will be usedComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be use. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
--tls-min-version string
Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants.Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12
--tls-private-key-file string
File containing the default x509 private key matching --tls-cert-file.File containing the default x509 private key matching --tls-cert-file.
--tls-sni-cert-key namedCertKey     Default: []
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".
--unhealthy-zone-threshold float32     Default: 0.55
Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy.
--use-service-account-credentials
If true, use individual service account credentials for each controller.If true, use individual service account credentials for each controller.
--version version[=true]
Print version information and quitPrint version information and quit
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-proxy.md b/content/en/docs/reference/command-line-tools-reference/kube-proxy.md index 015f57a95e4b6..848eaf3994009 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-proxy.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-proxy.md @@ -1,12 +1,14 @@ --- title: kube-proxy notitle: true -weight: 60 --- ## kube-proxy + + ### Synopsis + The Kubernetes network proxy runs on each node. This reflects services as defined in the Kubernetes API on each node and can do simple TCP and UDP stream forwarding or round robin TCP and UDP forwarding across a set of backends. @@ -21,239 +23,288 @@ kube-proxy [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--bind-address 0.0.0.0     Default: 0.0.0.0
The IP address for the proxy server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)The IP address for the proxy server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--cleanup
If true cleanup iptables and ipvs rules and exit.If true cleanup iptables and ipvs rules and exit.
--cleanup-ipvs     Default: true
If true make kube-proxy cleanup ipvs rules before running. Default is trueIf true make kube-proxy cleanup ipvs rules before running. Default is true
--cluster-cidr string
The CIDR range of pods in the cluster. When configured, traffic sent to a Service cluster IP from outside this range will be masqueraded and traffic sent from pods to an external LoadBalancer IP will be directed to the respective cluster IP insteadThe CIDR range of pods in the cluster. When configured, traffic sent to a Service cluster IP from outside this range will be masqueraded and traffic sent from pods to an external LoadBalancer IP will be directed to the respective cluster IP instead
--config string
The path to the configuration file.The path to the configuration file.
--config-sync-period duration     Default: 15m0s
How often configuration from the apiserver is refreshed. Must be greater than 0.How often configuration from the apiserver is refreshed. Must be greater than 0.
--conntrack-max-per-core int32     Default: 32768
Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min).Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min).
--conntrack-min int32     Default: 131072
Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is).Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is).
--conntrack-tcp-timeout-close-wait duration     Default: 1h0m0s
NAT timeout for TCP connections in the CLOSE_WAIT stateNAT timeout for TCP connections in the CLOSE_WAIT state
--conntrack-tcp-timeout-established duration     Default: 24h0m0s
Idle timeout for established TCP connections (0 to leave as-is)Idle timeout for established TCP connections (0 to leave as-is)
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
--healthz-bind-address 0.0.0.0     Default: 0.0.0.0:10256
The IP address and port for the health check server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)The IP address and port for the health check server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--healthz-port int32     Default: 10256
The port to bind the health check server. Use 0 to disable.The port to bind the health check server. Use 0 to disable.
-h, --help
help for kube-proxyhelp for kube-proxy
--hostname-override string
If non-empty, will use this string as identification instead of the actual hostname.If non-empty, will use this string as identification instead of the actual hostname.
--iptables-masquerade-bit int32     Default: 14
If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31].If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31].
--iptables-min-sync-period duration
The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').
--iptables-sync-period duration     Default: 30s
The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.
--ipvs-exclude-cidrs stringSlice
A comma-separated list of CIDR's which the ipvs proxier should not touch when cleaning up IPVS rules.
--ipvs-min-sync-period duration
The minimum interval of how often the ipvs rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').The minimum interval of how often the ipvs rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').
--ipvs-scheduler string
The ipvs scheduler type when proxy mode is ipvsThe ipvs scheduler type when proxy mode is ipvs
--ipvs-sync-period duration     Default: 30s
The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.
--kube-api-burst int32     Default: 10
Burst to use while talking with kubernetes apiserverBurst to use while talking with kubernetes apiserver
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.Content type of requests sent to apiserver.
--kube-api-qps float32     Default: 5
QPS to use while talking with kubernetes apiserverQPS to use while talking with kubernetes apiserver
--kubeconfig string
Path to kubeconfig file with authorization information (the master location is set by the master flag).Path to kubeconfig file with authorization information (the master location is set by the master flag).
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--masquerade-all
If using the pure iptables proxy, SNAT all traffic sent via Service cluster IPs (this not commonly needed)If using the pure iptables proxy, SNAT all traffic sent via Service cluster IPs (this not commonly needed)
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig)The address of the Kubernetes API server (overrides any value in kubeconfig)
--metrics-bind-address 0.0.0.0     Default: 127.0.0.1:10249
The IP address and port for the metrics server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)The IP address and port for the metrics server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--nodeport-addresses stringSlice
A string slice of values which specify the addresses to use for NodePorts. Values may be valid IP blocks (e.g. 1.2.3.0/24, 1.2.3.4/32). The default empty string slice ([]) means to use all local addresses.A string slice of values which specify the addresses to use for NodePorts. Values may be valid IP blocks (e.g. 1.2.3.0/24, 1.2.3.4/32). The default empty string slice ([]) means to use all local addresses.
--oom-score-adj int32     Default: -999
The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000]The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000]
--profiling
If true enables profiling via web interface on /debug/pprof handler.If true enables profiling via web interface on /debug/pprof handler.
--proxy-mode ProxyMode
Which proxy mode to use: 'userspace' (older) or 'iptables' (faster) or 'ipvs' (experimental). If blank, use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.Which proxy mode to use: 'userspace' (older) or 'iptables' (faster) or 'ipvs' (experimental). If blank, use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.
--proxy-port-range port-range
Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.Range of host ports (beginPort-endPort, single port or beginPort+offset, inclusive) that may be consumed in order to proxy service traffic. If (unspecified, 0, or 0-0) then ports will be randomly chosen.
--udp-timeout duration     Default: 250ms
How long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspaceHow long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspace
--version version[=true]
Print version information and quitPrint version information and quit
--write-config-to string
If set, write the default configuration values to this file and exit.If set, write the default configuration values to this file and exit.
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md b/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md index ab0acc7e5e5bc..382ba3784b36f 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md @@ -1,12 +1,14 @@ --- title: kube-scheduler notitle: true -weight: 70 --- ## kube-scheduler + + ### Synopsis + The Kubernetes scheduler is a policy-rich, topology-aware, workload-specific function that significantly impacts availability, performance, and capacity. The scheduler needs to take into account individual and collective @@ -21,179 +23,218 @@ kube-scheduler [flags] ### Options - +
+ - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + - + + - + + - + + - + + - + + + + + + + + +
--address string--address string     Default: "0.0.0.0"
The IP address to serve on (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See --bind-address instead.
--algorithm-provider string
The scheduling algorithm provider to use, one of: ClusterAutoscalerProvider | DefaultProviderDEPRECATED: the scheduling algorithm provider to use, one of: ClusterAutoscalerProvider | DefaultProvider
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--config string
The path to the configuration file.The path to the configuration file. Flags override values in this file.
--contention-profiling
Enable lock contention profiling, if profiling is enabledDEPRECATED: enable lock contention profiling, if profiling is enabled
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
-h, --help
help for kube-schedulerhelp for kube-scheduler
--kube-api-burst int32     Default: 100
Burst to use while talking with kubernetes apiserverDEPRECATED: burst to use while talking with kubernetes apiserver
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.DEPRECATED: content type of requests sent to apiserver.
--kube-api-qps float32     Default: 50
QPS to use while talking with kubernetes apiserverDEPRECATED: QPS to use while talking with kubernetes apiserver
--kubeconfig string
Path to kubeconfig file with authorization and master location information.DEPRECATED: path to kubeconfig file with authorization and master location information.
--leader-elect     Default: true
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.
--leader-elect-lease-duration duration     Default: 15s
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.
--leader-elect-renew-deadline duration     Default: 10s
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.
--leader-elect-resource-lock endpoints     Default: "endpoints"
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-retry-period duration     Default: 2s
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.
--lock-object-name string     Default: "kube-scheduler"
Define the name of the lock object.DEPRECATED: define the name of the lock object.
--lock-object-namespace string     Default: "kube-system"
Define the namespace of the lock object.DEPRECATED: define the namespace of the lock object.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig)The address of the Kubernetes API server (overrides any value in kubeconfig)
--policy-config-file string
File with scheduler policy configuration. This file is used if policy ConfigMap is not provided or --use-legacy-policy-config==trueDEPRECATED: file with scheduler policy configuration. This file is used if policy ConfigMap is not provided or --use-legacy-policy-config=true
--policy-configmap string
Name of the ConfigMap object that contains scheduler's policy configuration. It must exist in the system namespace before scheduler initialization if --use-legacy-policy-config==false. The config must be provided as the value of an element in 'Data' map with the key='policy.cfg'DEPRECATED: name of the ConfigMap object that contains scheduler's policy configuration. It must exist in the system namespace before scheduler initialization if --use-legacy-policy-config=false. The config must be provided as the value of an element in 'Data' map with the key='policy.cfg'
--policy-configmap-namespace string--policy-configmap-namespace string     Default: "kube-system"
The namespace where policy ConfigMap is located. The system namespace will be used if this is not provided or is empty.DEPRECATED: the namespace where policy ConfigMap is located. The kube-system namespace will be used if this is not provided or is empty.
--port int32     Default: 10251--port int     Default: 10251
The port that the scheduler's http service runs onDEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.
--profiling
Enable profiling via web interface host:port/debug/pprof/DEPRECATED: enable profiling via web interface host:port/debug/pprof/
--scheduler-name string     Default: "default-scheduler"
Name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's "spec.SchedulerName".DEPRECATED: name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's "spec.schedulerName".
--use-legacy-policy-config
When set to true, scheduler will ignore policy ConfigMap and uses policy config fileDEPRECATED: when set to true, scheduler will ignore policy ConfigMap and uses policy config file
--version version[=true]
Print version information and quitPrint version information and quit
--write-config-to string
If set, write the configuration values to this file and exit.
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kubelet.md b/content/en/docs/reference/command-line-tools-reference/kubelet.md index 1026c4fc4884a..2f4007b06e6ae 100644 --- a/content/en/docs/reference/command-line-tools-reference/kubelet.md +++ b/content/en/docs/reference/command-line-tools-reference/kubelet.md @@ -1,7 +1,6 @@ --- title: kubelet notitle: true -weight: 20 --- ## kubelet @@ -31,772 +30,48 @@ HTTP server: The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest. ``` -kubelet +kubelet [flags] ``` ### Options - +
- - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - + - + + - + - + + - - - - - - - - - - - - - + +
--address 0.0.0.0     Default: 0.0.0.0
The IP address for the Kubelet to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--allow-privileged
If true, allow containers to request privileged mode.
--anonymous-auth     Default: true
Enables anonymous requests to the Kubelet server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.
--authentication-token-webhook
Use the TokenReview API to determine authentication for bearer tokens.
--authentication-token-webhook-cache-ttl duration     Default: 2m0s
The duration to cache responses from the webhook token authenticator.
--authorization-mode string     Default: "AlwaysAllow"
Authorization mode for Kubelet server. Valid options are AlwaysAllow or Webhook. Webhook mode uses the SubjectAccessReview API to determine authorization.
--authorization-webhook-cache-authorized-ttl duration     Default: 5m0s
The duration to cache 'authorized' responses from the webhook authorizer.
--authorization-webhook-cache-unauthorized-ttl duration     Default: 30s
The duration to cache 'unauthorized' responses from the webhook authorizer.
--azure-container-registry-config string
Path to the file container Azure container registry configuration information.
--bootstrap-checkpoint-path string
Path to to the directory where the checkpoints are stored
--bootstrap-kubeconfig string
Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by --kubeconfig does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated client certificate and key is written to the path specified by --kubeconfig. The client certificate and key file will be stored in the directory pointed by --cert-dir.
--cadvisor-port int32     Default: 4194
The port of the localhost cAdvisor endpoint (set to 0 to disable)
--cert-dir string     Default: "/var/lib/kubelet/pki"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--cgroup-driver string     Default: "cgroupfs"
Driver that the kubelet uses to manipulate cgroups on the host. Possible values: 'cgroupfs', 'systemd'
--cgroup-root string
Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
--cgroups-per-qos     Default: true
Enable creation of QoS cgroup hierarchy, if true top level QoS and pod cgroups are created.
--chaos-chance float
If > 0.0, introduce random client errors and latency. Intended for testing.
--client-ca-file string
If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider for cloud services. Specify empty string for running with no cloud provider.
--cluster-dns stringSlice
Comma-separated list of DNS server IP address. This value is used for containers DNS server in case of Pods with "dnsPolicy=ClusterFirst". Note: all DNS servers appearing in the list MUST serve the same set of records otherwise name resolution within the cluster may not work correctly. There is no guarantee as to which DNS server may be contacted for name resolution.
--cluster-domain string
Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
--cni-bin-dir string
The full path of the directory in which to search for CNI plugin binaries. Default: /opt/cni/bin
--cni-conf-dir string
The full path of the directory in which to search for CNI config files. Default: /etc/cni/net.d
--config string
The Kubelet will load its initial configuration from this file. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Omit this flag to use the built-in default configuration values. You must also enable the KubeletConfigFile feature gate to pass this flag.
--container-runtime string     Default: "docker"
The container runtime to use. Possible values: 'docker', 'rkt'.
--container-runtime-endpoint string     Default: "unix:///var/run/dockershim.sock"
[Experimental] The endpoint of remote runtime service. Currently unix socket is supported on Linux, and tcp is supported on windows. Examples:'unix:///var/run/dockershim.sock', 'tcp://localhost:3735'
--containerized
Experimental support for running kubelet in a container. Intended for testing.
--contention-profiling
Enable lock contention profiling, if profiling is enabled
--cpu-cfs-quota     Default: true
Enable CPU CFS quota enforcement for containers that specify CPU limits
--cpu-manager-policy string     Default: "none"
CPU Manager policy to use. Possible values: 'none', 'static'. Default: 'none'
--cpu-manager-reconcile-period NodeStatusUpdateFrequency     Default: 10s
CPU Manager reconciliation period. Examples: '10s', or '1m'. If not supplied, defaults to NodeStatusUpdateFrequency
--docker-disable-shared-pid     Default: true
The Container Runtime Interface (CRI) defaults to using a shared PID namespace for containers in a pod when running with Docker 1.13.1 or higher. Setting this flag reverts to the previous behavior of isolated PID namespaces. This ability will be removed in a future Kubernetes release.
--docker-endpoint string     Default: "unix:///var/run/docker.sock"
Use this for the docker endpoint to communicate with
--dynamic-config-dir string
The Kubelet will use this directory for checkpointing downloaded configurations and tracking configuration health. The Kubelet will create this directory if it does not already exist. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Providing this flag enables dynamic Kubelet configuration. Presently, you must also enable the DynamicKubeletConfig feature gate to pass this flag.
--enable-controller-attach-detach     Default: true
Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations
--enable-debugging-handlers     Default: true
Enables server endpoints for log collection and local running of containers and commands
--enable-server     Default: true
Enable the Kubelet's server
--enforce-node-allocatable stringSlice     Default: [pods]
A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptable options are 'pods', 'system-reserved' & 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' & '--kube-reserved-cgroup' must also be set respectively. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details.
--event-burst int32     Default: 10
Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0
--event-qps int32     Default: 5
If > 0, limit event creations per second to this value. If 0, unlimited.
--eviction-hard mapStringString     Default: imagefs.available<15%!,(MISSING)memory.available<100Mi,nodefs.available<10%!,(MISSING)nodefs.inodesFree<5%!<(MISSING)/td> -
A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction.
--eviction-max-pod-grace-period int32
Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value.
--eviction-minimum-reclaim mapStringString
A set of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure.
--eviction-pressure-transition-period duration     Default: 5m0s
Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition.
--eviction-soft mapStringString
A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction.
--eviction-soft-grace-period mapStringString
A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction.
--exit-on-lock-contention
Whether kubelet should exit upon lock-file contention.
--experimental-allocatable-ignore-eviction
When set to 'true', Hard Eviction Thresholds will be ignored while calculating Node Allocatable. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details. [default=false]
--experimental-allowed-unsafe-sysctls stringSlice
Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk.
--experimental-bootstrap-kubeconfig string
deprecated: use --bootstrap-kubeconfig
--experimental-check-node-capabilities-before-mount
[Experimental] if set true, the kubelet will check the underlying node for required components (binaries, etc.) before performing the mount
--experimental-kernel-memcg-notification
If enabled, the kubelet will integrate with the kernel memcg notification to determine if memory eviction thresholds are crossed rather than polling.
--experimental-mounter-path string
[Experimental] Path of mounter binary. Leave empty to use the default mount.
--experimental-qos-reserved mapStringString
A set of ResourceName=Percentage (e.g. memory=50%!)(MISSING) pairs that describe how pod resource requests are reserved at the QoS level. Currently only memory is supported. [default=none]
--fail-swap-on     Default: true
Makes the Kubelet fail to start if swap is enabled on the node.
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AllowExtTrafficLocalEndpoints=true|false (default=true)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CSIPersistentVolume=true|false (ALPHA - default=false)
CustomPodDNS=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HugePages=true|false (BETA - default=true)
Initializers=true|false (ALPHA - default=false)
KubeletConfigFile=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (ALPHA - default=false)
PVCProtection=true|false (ALPHA - default=false)
PersistentLocalVolumes=true|false (ALPHA - default=false)
PodPriority=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
VolumeScheduling=true|false (ALPHA - default=false)
--file-check-frequency duration     Default: 20s
Duration between checking config files for new data
--google-json-key string
The Google Cloud Platform Service Account JSON Key to use for authentication.
--hairpin-mode string     Default: "promiscuous-bridge"
How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none".
--healthz-bind-address 0.0.0.0     Default: 127.0.0.1
The IP address for the healthz server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--healthz-port int32     Default: 10248
The port of the localhost healthz endpoint (set to 0 to disable)
--host-ipc-sources stringSlice     Default: [*]
Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace.
--host-network-sources stringSlice     Default: [*]
Comma-separated list of sources from which the Kubelet allows pods to use of host network.
--host-pid-sources stringSlice     Default: [*]
Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace.
--hostname-override string
If non-empty, will use this string as identification instead of the actual hostname.
--http-check-frequency duration     Default: 20s
Duration between checking http for new data
--image-gc-high-threshold int32     Default: 85
The percent of disk usage after which image garbage collection is always run.
--image-gc-low-threshold int32     Default: 80
The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to.
--image-pull-progress-deadline duration     Default: 1m0s
If no pulling progress is made before this deadline, the image pulling will be cancelled.
--image-service-endpoint string
[Experimental] The endpoint of remote image service. If not specified, it will be the same with container-runtime-endpoint by default. Currently unix socket is supported on Linux, and tcp is supported on windows. Examples:'unix:///var/run/dockershim.sock', 'tcp://localhost:3735'
--iptables-drop-bit int32     Default: 15
The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31].
--iptables-masquerade-bit int32     Default: 14
The bit of the fwmark space to mark packets for SNAT. Must be within the range [0, 31]. Please match this parameter with corresponding parameter in kube-proxy.
--kube-api-burst int32     Default: 10
Burst to use while talking with kubernetes apiserver
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.
--kube-api-qps int32     Default: 5
QPS to use while talking with kubernetes apiserver
--kube-reserved mapStringString
A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi) pairs that describe resources reserved for kubernetes system components. Currently cpu, memory and local ephemeral storage for root file system are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]
--kube-reserved-cgroup string
Absolute name of the top level cgroup that is used to manage kubernetes components for which compute resources were reserved via '--kube-reserved' flag. Ex. '/kube-reserved'. [default='']
--kubeconfig string     Default: "/var/lib/kubelet/kubeconfig"
Path to a kubeconfig file, specifying how to connect to the API server.
--kubelet-cgroups string
Optional absolute name of cgroups to create and run the Kubelet in.
--lock-file string
The path to file for kubelet to use as a lock file.
--make-iptables-util-chains     Default: true
If true, kubelet will ensure iptables utility rules are present on host.
--manifest-url string
URL for accessing the container manifest
--manifest-url-header --manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful'
Comma-separated list of HTTP headers to use when accessing the manifest URL. Multiple headers with the same name will be added in the same order provided. This flag can be repeatedly invoked. For example: --manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful'
--max-open-files int     Default: 1000000
Number of files that can be opened by Kubelet process.
--max-pods int32     Default: 110
Number of Pods that can run on this Kubelet.
--minimum-image-ttl-duration duration     Default: 2m0s
Minimum age for an unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'.
--network-plugin string
The name of the network plugin to be invoked for various events in kubelet/pod lifecycle
--network-plugin-mtu int32
The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU.
--node-ip string
IP address of the node. If set, kubelet will use this IP address for the node
--node-labels mapStringString
Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','.
--node-status-update-frequency duration     Default: 10s
Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller.
--oom-score-adj int32     Default: -999
The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000]
--pod-cidr string
The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master.
--pod-infra-container-image string     Default: "gcr.io/google_containers/pause-amd64:3.1"
The image whose network/ipc namespaces containers in each pod will use.
--pod-manifest-path string
Path to the directory containing pod manifest files to run, or the path to a single pod manifest file. Files starting with dots will be ignored.
--pods-per-core int32
Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this calculation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit.
--port int32     Default: 10250
The port for the Kubelet to serve on.
--protect-kernel-defaults
Default kubelet behaviour for kernel tuning. If set, kubelet errors if any of kernel tunables is different than kubelet defaults.
--provider-id string
Unique identifier for identifying the node in a machine database, i.e cloudprovider
--read-only-port int32     Default: 10255
The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable)
--really-crash-for-testing
If true, when panics occur crash. Intended for testing.
--register-node     Default: true
Register the node with the apiserver. If --kubeconfig is not provided, this flag is irrelevant, as the Kubelet won't have an apiserver to register with. Default=true.
--register-with-taints []api.Taint
Register the node with the given list of taints (comma separated "=:"). No-op if register-node is false.
--registry-burst int32     Default: 10
Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry-qps. Only used if --registry-qps > 0
--registry-qps int32     Default: 5
If > 0, limit registry pull QPS to this value. If 0, unlimited.
--resolv-conf string     Default: "/etc/resolv.conf"
Resolver configuration file used as the basis for the container DNS resolution configuration.
--rkt-api-endpoint string     Default: "localhost:15441"
The endpoint of the rkt API service to communicate with. Only used if --container-runtime='rkt'.
--rkt-path string
Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt'.
--root-dir string     Default: "/var/lib/kubelet"
Directory path for managing kubelet files (volume mounts,etc).
--rotate-certificates
Auto rotate the kubelet client certificates by requesting new certificates from the kube-apiserver when the certificate expiration approaches.
--runonce
If true, exit after spawning pods from local manifests or remote urls. Exclusive with --enable-server
--runtime-cgroups string
Optional absolute name of cgroups to create and run the runtime in.
--runtime-request-timeout duration     Default: 2m0s
Timeout of all runtime requests except long running request - pull, logs, exec and attach. When timeout exceeded, kubelet will cancel the request, throw out an error and retry later.
--seccomp-profile-root string     Default: "/var/lib/kubelet/seccomp"
Directory path for seccomp profiles.
--serialize-image-pulls     Default: true
Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details.
--streaming-connection-idle-timeout duration     Default: 4h0m0s
Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m'
--sync-frequency duration     Default: 1m0s
Max period between synchronizing running containers and config
--system-cgroups /
Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under /. Empty for no container. Rolling back the flag requires a reboot.
--system-reserved mapStringString
A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]
--system-reserved-cgroup string
Absolute name of the top level cgroup that is used to manage non-kubernetes components for which compute resources were reserved via '--system-reserved' flag. Ex. '/system-reserved'. [default='']Path to the file containing Azure container registry configuration information.
--tls-cert-file string-h, --help
File containing x509 Certificate used for serving HTTPS (with intermediate certs, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir.help for kubelet
--tls-private-key-file string--log-flush-frequency duration     Default: 5s
File containing x509 private key matching --tls-cert-file.Maximum number of seconds between log flushes
--version version[=true]
Print version information and quit
--volume-plugin-dir string     Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"
The full path of the directory in which to search for additional third party volume plugins
--volume-stats-agg-period duration     Default: 1m0s
Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0.Print version information and quit
+ + + diff --git a/content/en/docs/reference/federation/extensions/v1beta1/definitions.html b/content/en/docs/reference/federation/extensions/v1beta1/definitions.html index cdeef7b790c04..f3bafaf1493c8 100755 --- a/content/en/docs/reference/federation/extensions/v1beta1/definitions.html +++ b/content/en/docs/reference/federation/extensions/v1beta1/definitions.html @@ -683,6 +683,13 @@

v1beta1.DaemonSetStatus

integer (int32)

+ +

conditions

+

Represents the latest available observations of a DaemonSet’s current state.

+

false

+

v1beta1.DaemonSetCondition array

+ + @@ -1984,7 +1991,7 @@

v1.ObjectMeta

deletionTimestamp

-

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

false

@@ -2309,7 +2316,7 @@

v1.ISCSIVolumeSource

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

+

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

@@ -2323,14 +2330,14 @@

v1.ISCSIVolumeSource

lun

-

iSCSI target lun number.

+

iSCSI Target Lun number.

true

integer (int32)

iscsiInterface

-

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

+

iSCSI Interface Name that uses an iSCSI transport. Defaults to default (tcp).

false

string

@@ -2351,7 +2358,7 @@

v1.ISCSIVolumeSource

portals

-

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

+

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

false

string array

@@ -2372,14 +2379,14 @@

v1.ISCSIVolumeSource

secretRef

-

CHAP secret for iSCSI target and initiator authentication

+

CHAP Secret for iSCSI target and initiator authentication

false

v1.LocalObjectReference

initiatorName

-

Custom iSCSI initiator name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

+

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

false

string

@@ -2557,8 +2564,8 @@

v1.PodAffinityTerm

topologyKey

-

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. For PreferredDuringScheduling pod anti-affinity, empty topologyKey is interpreted as "all topologies" ("all topologies" here means all the topologyKeys indicated by scheduler command-line argument --failure-domains); for affinity and for RequiredDuringScheduling pod anti-affinity, empty topologyKey is not allowed.

-

false

+

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

+

true

string

@@ -2591,7 +2598,7 @@

v1.EnvFromSource

prefix

-

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

+

An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

false

string

@@ -2880,7 +2887,7 @@

v1.SecretVolumeSource

v1.FlexVolumeSource

-

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

+

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

@@ -3305,7 +3312,7 @@

v1.DeleteOptions

- + @@ -3478,7 +3485,7 @@

v1.Volume

- + @@ -4076,7 +4083,7 @@

v1.PodSpec

- + @@ -4207,6 +4214,13 @@

v1.PodSpec

+ + + + + + +

propagationPolicy

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

v1.DeletionPropagation

flexVolume

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

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

false

v1.FlexVolumeSource

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirstWithHostNet, ClusterFirst or Default. Defaults to "ClusterFirst". To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ClusterFirstWithHostNet.

Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are ClusterFirstWithHostNet, ClusterFirst, Default or None. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ClusterFirstWithHostNet. Note that None policy is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.

false

string

integer (int32)

dnsConfig

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. This is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.

false

v1.PodDNSConfig
@@ -5026,6 +5040,54 @@

v1.Status

+
+
+

v1.PodDNSConfig

+
+

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

nameservers

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

false

string array

searches

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

false

string array

options

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

false

v1.PodDNSConfigOption array

+

v1beta1.ScaleStatus

@@ -5775,6 +5837,13 @@

v1.Container

+

volumeDevices

+

volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.

+

false

+

v1.VolumeDevice array

+ + +

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

false

@@ -6139,6 +6208,47 @@

v1.APIResource

+
+
+

v1.VolumeDevice

+
+

volumeDevice describes a mapping of a raw block device within a container.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

name must match the name of a persistentVolumeClaim in the pod

true

string

devicePath

devicePath is the path inside of the container that the device will be mapped to.

true

string

+

v1.NodeSelectorRequirement

@@ -6341,6 +6451,47 @@

v1.SecretProjection

+
+
+

v1.PodDNSConfigOption

+
+

PodDNSConfigOption defines DNS resolver options of a pod.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

Required.

false

string

value

false

string

+

v1beta1.DaemonSet

@@ -7205,6 +7356,68 @@

v1.PreferredSchedulingTerm

+
+
+

v1beta1.DaemonSetCondition

+
+

DaemonSetCondition describes the state of a DaemonSet at a certain point.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

type

Type of DaemonSet condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

+

v1.ConfigMapKeySelector

diff --git a/content/en/docs/reference/federation/extensions/v1beta1/operations.html b/content/en/docs/reference/federation/extensions/v1beta1/operations.html index 26449a64e51d9..18187972174a3 100755 --- a/content/en/docs/reference/federation/extensions/v1beta1/operations.html +++ b/content/en/docs/reference/federation/extensions/v1beta1/operations.html @@ -1787,7 +1787,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

@@ -3209,7 +3209,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

@@ -5152,7 +5152,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

@@ -6574,7 +6574,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

diff --git a/content/en/docs/reference/federation/v1/definitions.html b/content/en/docs/reference/federation/v1/definitions.html index ca4e573991238..82a8434e7428f 100755 --- a/content/en/docs/reference/federation/v1/definitions.html +++ b/content/en/docs/reference/federation/v1/definitions.html @@ -1030,6 +1030,48 @@

v1.Event

string

+ +

eventTime

+

Time when this Event was first observed.

+

false

+

string

+ + + +

series

+

Data about the Event series this event represents or nil if it’s a singleton Event.

+

false

+

v1.EventSeries

+ + + +

action

+

What action was taken/failed regarding to the Regarding object.

+

false

+

string

+ + + +

related

+

Optional secondary object for more complex actions.

+

false

+

v1.ObjectReference

+ + + +

reportingComponent

+

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.

+

true

+

string

+ + + +

reportingInstance

+

ID of the controller instance, e.g. kubelet-xyzf.

+

true

+

string

+ + @@ -1385,7 +1427,7 @@

v1.DeleteOptions

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

v1.DeletionPropagation

@@ -1393,6 +1435,54 @@

v1.DeleteOptions

+
+
+

v1.EventSeries

+
+

EventSeries contain information on series of events, i.e. thing that was/is happening continously for some time.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

count

Number of occurrences in this series up to the last heartbeat time

false

integer (int32)

lastObservedTime

Time of the last occurence observed

false

string

state

State of this Series: Ongoing or Finished

false

string

+

v1.StatusDetails

@@ -1509,7 +1599,14 @@

v1.ConfigMap

data

-

Data contains the configuration data. Each key must consist of alphanumeric characters, -, _ or ..

+

Data contains the configuration data. Each key must consist of alphanumeric characters, -, _ or .. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

+

false

+

object

+ + + +

binaryData

+

BinaryData contains the binary data. Each key must consist of alphanumeric characters, -, _ or .. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.

false

object

@@ -1945,7 +2042,7 @@

v1.ObjectMeta

deletionTimestamp

-

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
+

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

false

@@ -2267,7 +2364,7 @@

v1.ServiceSpec

externalName

-

externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.

+

externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.

false

string

diff --git a/content/en/docs/reference/federation/v1/operations.html b/content/en/docs/reference/federation/v1/operations.html index eef0937454868..98a18c2278e54 100755 --- a/content/en/docs/reference/federation/v1/operations.html +++ b/content/en/docs/reference/federation/v1/operations.html @@ -1908,7 +1908,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

@@ -2946,7 +2946,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

@@ -3984,7 +3984,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

@@ -5022,7 +5022,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

@@ -5941,7 +5941,7 @@

Parameters

QueryParameter

propagationPolicy

-

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

+

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground.

false

string

diff --git a/content/en/docs/reference/kubectl/kubectl.md b/content/en/docs/reference/kubectl/kubectl.md index dd968f8e3f95c..923ad9a84c3a6 100755 --- a/content/en/docs/reference/kubectl/kubectl.md +++ b/content/en/docs/reference/kubectl/kubectl.md @@ -2,6 +2,7 @@ title: kubectl notitle: true --- + ## kubectl kubectl controls the Kubernetes cluster manager @@ -36,13 +37,11 @@ kubectl [flags] --logtostderr log to standard error instead of files --match-server-version Require server version to match client version -n, --namespace string If present, the namespace scope for this CLI request - --password string Password for basic authentication to the API server --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") -s, --server string The address and port of the Kubernetes API server --stderrthreshold severity logs at or above this threshold go to stderr (default 2) --token string Bearer token for authentication to the API server --user string The name of the kubeconfig user to use - --username string Username for basic authentication to the API server -v, --v Level log level for V logs --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` @@ -51,6 +50,7 @@ kubectl [flags] * [kubectl alpha](kubectl_alpha.md) - Commands for features in alpha * [kubectl annotate](kubectl_annotate.md) - Update the annotations on a resource +* [kubectl api-resources](kubectl_api-resources.md) - Print the supported API resources on the server * [kubectl api-versions](kubectl_api-versions.md) - Print the supported API versions on the server, in the form of "group/version" * [kubectl apply](kubectl_apply.md) - Apply a configuration to a resource by filename or stdin * [kubectl attach](kubectl_attach.md) - Attach to a running container @@ -80,7 +80,6 @@ kubectl [flags] * [kubectl port-forward](kubectl_port-forward.md) - Forward one or more local ports to a pod * [kubectl proxy](kubectl_proxy.md) - Run a proxy to the Kubernetes API server * [kubectl replace](kubectl_replace.md) - Replace a resource by filename or stdin -* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController * [kubectl rollout](kubectl_rollout.md) - Manage the rollout of a resource * [kubectl run](kubectl_run.md) - Run a particular image on the cluster * [kubectl scale](kubectl_scale.md) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job @@ -89,5 +88,6 @@ kubectl [flags] * [kubectl top](kubectl_top.md) - Display Resource (CPU/Memory/Storage) usage. * [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable * [kubectl version](kubectl_version.md) - Print the client and server version information +* [kubectl wait](kubectl_wait.md) - Experimental: Wait for one condition on one or many resources -###### Auto generated by spf13/cobra on 25-Mar-2018 +###### Auto generated by spf13/cobra on 16-Jun-2018 diff --git a/content/en/docs/reference/kubectl/overview.md b/content/en/docs/reference/kubectl/overview.md index d7207926700f5..1d88c3cab8745 100644 --- a/content/en/docs/reference/kubectl/overview.md +++ b/content/en/docs/reference/kubectl/overview.md @@ -203,15 +203,18 @@ submit-queue 610995 This means that for any given resource, the server will return columns and rows relevant to that resource, for the client to print. This allows for consistent human-readable output across clients used against the same cluster, by having the server encapsulate the details of printing. -To output object information using this feature, you can add the `--experimental-server-print` flag to a supported `kubectl` command. +This feature is enabled by default in `kubectl` 1.11 and higher. To disable it, add the +`--server-print=false` flag to the `kubectl get` command. ##### Examples +To print information about the status of a pod, use a command like the following: + ```shell -$ kubectl get pods --experimental-server-print +kubectl get pods --server-print=false ``` -The result of running this command is: +Output looks like this: ```shell NAME READY STATUS RESTARTS AGE diff --git a/content/en/docs/reference/kubernetes-api/index.md b/content/en/docs/reference/kubernetes-api/index.md index 3d693134b1361..8c2c6fab839b7 100644 --- a/content/en/docs/reference/kubernetes-api/index.md +++ b/content/en/docs/reference/kubernetes-api/index.md @@ -1,5 +1,5 @@ --- -title: v1.10 +title: v1.11 --- -[Kubernetes API v1.10](/docs/reference/generated/kubernetes-api/v1.10/) +[Kubernetes API v1.11](/docs/reference/generated/kubernetes-api/v1.11/) diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md index 4dfddf9c61c46..9c36cd372ecc9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md @@ -39,7 +39,7 @@ Example usage: ### Options - +
@@ -50,7 +50,7 @@ Example usage: - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md index 63bcf58f03d63..def246a453795 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md @@ -8,7 +8,7 @@ Experimental sub-commands not yet fully functional. ### Options -
-h, --help
help for kubeadmhelp for kubeadm
+
@@ -19,7 +19,7 @@ Experimental sub-commands not yet fully functional. - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md index f72c52b0dc5cb..aa175471cac11 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
-h, --help
help for alphahelp for alpha
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md index f293951dbdee8..52689eee0cf6a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
-h, --help
help for phasehelp for phase
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md index c83bbda153256..29655fd8c65ba 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md @@ -4,8 +4,7 @@ Installs all addons to a Kubernetes cluster ### Synopsis -Installs the kube-dns and the kube-proxys addons components via the API server. -Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. +Installs the CoreDNS and the kube-proxys addons components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. Alpha Disclaimer: this command is currently alpha. @@ -16,7 +15,7 @@ kubeadm alpha phase addon all [flags] ### Examples ``` - # Installs the kube-dns and the kube-proxys addons components via the API server, + # Installs the CoreDNS and the kube-proxys addons components via the API server, # functionally equivalent to what installed by kubeadm init. kubeadm alpha phase selfhosting from-staticpods @@ -24,7 +23,7 @@ kubeadm alpha phase addon all [flags] ### Options -
-h, --help
help for addonhelp for addon
+
@@ -35,77 +34,77 @@ kubeadm alpha phase addon all [flags] - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md new file mode 100644 index 0000000000000..0c17c292f349c --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md @@ -0,0 +1,84 @@ + +Installs the CoreDNS addon to a Kubernetes cluster + +### Synopsis + + +Installs the CoreDNS addon components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase addon coredns [flags] +``` + +### Options + +
--apiserver-advertise-address string
The IP address or DNS name the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for allhelp for all
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images fromChoose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPsThe range of IP address used for service VIPs
--service-dns-domain string     Default: "cluster.local"
Alternative domain for servicesAlternative domain for services
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for coredns
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPs
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md index 534834950bde3..40d91010cbe53 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md @@ -14,7 +14,7 @@ kubeadm alpha phase addon kube-proxy [flags] ### Options - +
@@ -25,56 +25,56 @@ kubeadm alpha phase addon kube-proxy [flags] - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md index 8629089198185..491ef4d66c8a8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--apiserver-advertise-address string
The IP address or DNS name the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for kube-proxyhelp for kube-proxy
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images fromChoose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
+
@@ -19,14 +19,14 @@ This command is not meant to be run on its own. See list of available subcommand - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md index a595bd4b98025..dd131e37d7ac9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md @@ -24,7 +24,7 @@ kubeadm alpha phase bootstrap-token all [flags] ### Options -
-h, --help
help for bootstrap-tokenhelp for bootstrap-token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -35,56 +35,56 @@ kubeadm alpha phase bootstrap-token all [flags] - + - + - + - + - + - + - + - + - + - + @@ -94,7 +94,7 @@ kubeadm alpha phase bootstrap-token all [flags] ### Options inherited from parent commands -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--description string     Default: "The default bootstrap token generated by 'kubeadm init'."--description string
A human friendly description of how this token is used.A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-h, --help
help for allhelp for all
--skip-token-print
Skip printing of the bootstrap tokenSkip printing of the bootstrap token
--token string
The token to use for establishing bidirectional trust between nodes and mastersThe token to use for establishing bidirectional trust between nodes and masters. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--ttl duration     Default: 24h0m0s--token-ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expireThe duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]
+
@@ -105,7 +105,7 @@ kubeadm alpha phase bootstrap-token all [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md index f8ad6866e3c7f..9e812e091641f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,7 +27,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] - + @@ -37,7 +37,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] ### Options inherited from parent commands -
-h, --help
help for cluster-infohelp for cluster-info
+
@@ -48,7 +48,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md index 7515ef09ed24d..d1cdf5d181ec1 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token create [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,56 +27,56 @@ kubeadm alpha phase bootstrap-token create [flags] - + - + - + - + - + - + - + - + - + - + @@ -86,7 +86,7 @@ kubeadm alpha phase bootstrap-token create [flags] ### Options inherited from parent commands -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--description string     Default: "The default bootstrap token generated by 'kubeadm init'."--description string
A human friendly description of how this token is used.A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-h, --help
help for createhelp for create
--skip-token-print
Skip printing of the bootstrap tokenSkip printing of the bootstrap token
--token string
The token to use for establishing bidirectional trust between nodes and mastersThe token to use for establishing bidirectional trust between nodes and masters. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--ttl duration     Default: 24h0m0s--token-ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expireThe duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]
+
@@ -97,7 +97,7 @@ kubeadm alpha phase bootstrap-token create [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md index 0ec18d7eac731..2128d7c290d88 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + @@ -29,7 +29,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options inherited from parent commands -
-h, --help
help for nodehelp for node
+
@@ -40,7 +40,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md index dcbd443e3e095..1d04250869bfd 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,7 +27,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] - + @@ -37,7 +37,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] ### Options inherited from parent commands -
-h, --help
help for allow-auto-approvehelp for allow-auto-approve
+
@@ -48,7 +48,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md index 7fa3f3043b9b6..713644e273b63 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,7 +27,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] - + @@ -37,7 +37,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] ### Options inherited from parent commands -
-h, --help
help for allow-post-csrshelp for allow-post-csrs
+
@@ -48,7 +48,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md index e780478c151f0..d7ce2c46a039d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md index b9eb8eb92eea8..f40cf7c0544fb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md @@ -28,7 +28,7 @@ kubeadm alpha phase certs all [flags] ### Options -
-h, --help
help for certshelp for certs
+
@@ -39,49 +39,49 @@ kubeadm alpha phase certs all [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md index 9968b1e83357f..0f93b4f2f6fe3 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs apiserver-etcd-client [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible on, to use for the API server serving certThe IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans stringSlice
Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns namesOptional extra altnames to use for the API server serving cert. Can be both IP addresses and DNS names
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for allhelp for all
--service-cidr string     Default: "10.96.0.0/12"
Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving certAlternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services, to use for the API server serving certAlternative domain for services, to use for the API server serving cert
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs apiserver-etcd-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md index af8d9cb7ae7e8..9772c823785c7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs apiserver-kubelet-client [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for apiserver-etcd-clienthelp for apiserver-etcd-client
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs apiserver-kubelet-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md index a4c6b1d03a622..6fa23650d3603 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md @@ -18,7 +18,7 @@ kubeadm alpha phase certs apiserver [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for apiserver-kubelet-clienthelp for apiserver-kubelet-client
+
@@ -29,49 +29,49 @@ kubeadm alpha phase certs apiserver [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md index 840a79833585b..2d13b77835581 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs ca [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible on, to use for the API server serving certThe IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans stringSlice
Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns namesOptional extra altnames to use for the API server serving cert. Can be both IP addresses and DNS names
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for apiserverhelp for apiserver
--service-cidr string     Default: "10.96.0.0/12"
Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving certAlternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services, to use for the API server serving certAlternative domain for services, to use for the API server serving cert
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs ca [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md index d3e04a46ac67f..23ccb50b8a613 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs etcd-ca [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for cahelp for ca
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs etcd-ca [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md index ecc45cc06b376..fa0abd61cc9cb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs etcd-healthcheck-client [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-cahelp for etcd-ca
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs etcd-healthcheck-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md index 54942af8ec24f..6a02d7f21ff43 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md @@ -18,7 +18,7 @@ kubeadm alpha phase certs etcd-peer [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-healthcheck-clienthelp for etcd-healthcheck-client
+
@@ -29,21 +29,21 @@ kubeadm alpha phase certs etcd-peer [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md index 704b0aecc92f1..9c7d9d95c5d0d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md @@ -18,7 +18,7 @@ kubeadm alpha phase certs etcd-server [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-peerhelp for etcd-peer
+
@@ -29,21 +29,21 @@ kubeadm alpha phase certs etcd-server [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md index 89d58039d6c99..3eed51d2acd3c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs front-proxy-ca [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-serverhelp for etcd-server
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs front-proxy-ca [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md index ace2d64d1d62a..072d83dfdd11c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs front-proxy-client [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for front-proxy-cahelp for front-proxy-ca
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs front-proxy-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md index 15eda50f3c01c..5d56ec7b5c276 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs sa [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for front-proxy-clienthelp for front-proxy-client
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs sa [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md index 9cd09759d59b8..a14adfcf4444c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for sahelp for sa
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md index d2fd4bc44a037..0a15bced4bdf2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md @@ -25,7 +25,7 @@ kubeadm alpha phase controlplane all [flags] ### Options -
-h, --help
help for controlplanehelp for controlplane
+
@@ -36,84 +36,84 @@ kubeadm alpha phase controlplane all [flags] - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md index 8a8d758b89550..3939b997f4476 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md @@ -1,5 +1,5 @@ -Generates the API server static Pod manifest. +Generates the API server static Pod manifest ### Synopsis @@ -14,7 +14,7 @@ kubeadm alpha phase controlplane apiserver [flags] ### Options -
--apiserver-advertise-address string
The IP address of the API server is accessible onThe IP address of the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--controller-manager-extra-args mapStringString
A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for allhelp for all
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPsThe range of IP address used for service VIPs
+
@@ -25,63 +25,63 @@ kubeadm alpha phase controlplane apiserver [flags] - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md index 85bee3294684c..004692b024d38 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md @@ -1,5 +1,5 @@ -Generates the controller-manager static Pod manifest. +Generates the controller-manager static Pod manifest ### Synopsis @@ -14,7 +14,7 @@ kubeadm alpha phase controlplane controller-manager [flags] ### Options -
--apiserver-advertise-address string
The IP address of the API server is accessible onThe IP address of the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for apiserverhelp for apiserver
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPsThe range of IP address used for service VIPs
+
@@ -25,42 +25,42 @@ kubeadm alpha phase controlplane controller-manager [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md index 8c6d1daca6339..d8bab2226e510 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md @@ -1,5 +1,5 @@ -Generates the scheduler static Pod manifest. +Generates the scheduler static Pod manifest ### Synopsis @@ -14,7 +14,7 @@ kubeadm alpha phase controlplane scheduler [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--controller-manager-extra-args mapStringString
A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>
-h, --help
help for controller-managerhelp for controller-manager
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
+
@@ -25,35 +25,35 @@ kubeadm alpha phase controlplane scheduler [flags] - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md index 85cada5d43dc5..285144797f46d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for schedulerhelp for scheduler
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md index 9b99b855c89a8..d3ca8e253a051 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md @@ -25,7 +25,7 @@ kubeadm alpha phase etcd local [flags] ### Options -
-h, --help
help for etcdhelp for etcd
+
@@ -36,21 +36,21 @@ kubeadm alpha phase etcd local [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md index 9357bae592467..1c7c61dd0c984 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for localhelp for local
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md index b3b0e8c28d666..4ed4e00b13647 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md @@ -14,7 +14,7 @@ kubeadm alpha phase kubeconfig admin [flags] ### Options -
-h, --help
help for kubeconfighelp for kubeconfig
+
@@ -25,42 +25,42 @@ kubeadm alpha phase kubeconfig admin [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md index cd72365ae534c..fa98914fbcdd2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md @@ -25,7 +25,7 @@ kubeadm alpha phase kubeconfig all [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for adminhelp for admin
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
+
@@ -36,49 +36,49 @@ kubeadm alpha phase kubeconfig all [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md index 87a07d1bd579e..6cae50ba82fe0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md @@ -14,7 +14,7 @@ kubeadm alpha phase kubeconfig controller-manager [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for allhelp for all
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
--node-name string
The node name that should be used for the kubelet client certificateThe node name that should be used for the kubelet client certificate
+
@@ -25,42 +25,42 @@ kubeadm alpha phase kubeconfig controller-manager [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md index 5d5129756c194..9eaa2c3521ab6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md @@ -1,5 +1,5 @@ -Generates a kubeconfig file for the kubelet to use. Please note that this should be used *only* for bootstrapping purposes. +Generates a kubeconfig file for the kubelet to use. Please note that this should be used *only* for bootstrapping purposes ### Synopsis @@ -16,7 +16,7 @@ kubeadm alpha phase kubeconfig kubelet [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for controller-managerhelp for controller-manager
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
+
@@ -27,49 +27,49 @@ kubeadm alpha phase kubeconfig kubelet [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md index 5a5551d8914df..b98f615b0bc9e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md @@ -14,7 +14,7 @@ kubeadm alpha phase kubeconfig scheduler [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for kubelethelp for kubelet
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
--node-name string
The node name that should be used for the kubelet client certificateThe node name that should be used for the kubelet client certificate
+
@@ -25,42 +25,42 @@ kubeadm alpha phase kubeconfig scheduler [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md index 0813ad24ea327..b2f43935eb484 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md @@ -21,7 +21,7 @@ kubeadm alpha phase kubeconfig user [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for schedulerhelp for scheduler
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
+
@@ -32,49 +32,56 @@ kubeadm alpha phase kubeconfig user [flags] - + - + - + - + - + - + + + + + + + + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet.md new file mode 100644 index 0000000000000..726a98890c565 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet.md @@ -0,0 +1,29 @@ + +Commands related to handling the kubelet. + +### Synopsis + + +This command is not meant to be run on its own. See list of available subcommands. + +### Options + +
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--client-name string
The name of user. It will be used as the CN if client certificates are createdThe name of user. It will be used as the CN if client certificates are created
-h, --help
help for userhelp for user
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
--org stringSlice
The orgnizations of the client certificate. It will be used as the O if client certificates are created
--token string
The token that should be used as the authentication mechanism for this kubeconfig (instead of client certificates)The token that should be used as the authentication mechanism for this kubeconfig, instead of client certificates
+ + + + + + + + + + + + + + +
-h, --help
help for kubelet
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config.md new file mode 100644 index 0000000000000..8f2958f6076b9 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config.md @@ -0,0 +1,29 @@ + +Handles kubelet configuration. + +### Synopsis + + +This command is not meant to be run on its own. See list of available subcommands. + +### Options + + + + + + + + + + + + + + + + +
-h, --help
help for config
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_download.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_download.md new file mode 100644 index 0000000000000..d8b3b3cd5f802 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_download.md @@ -0,0 +1,59 @@ + +Downloads the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet. + +### Synopsis + + +Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. Either kubeadm autodetects the kubelet version by exec-ing "kubelet --version" or respects the --kubelet-version parameter. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config download [flags] +``` + +### Examples + +``` + # Downloads the kubelet configuration from the ConfigMap in the cluster. Autodetects the kubelet version. + kubeadm alpha phase kubelet config download + + # Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version. + kubeadm alpha phase kubelet config download --kubelet-version v1.11.0 +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for download
--kubeconfig string     Default: "/etc/kubernetes/kubelet.conf"
The KubeConfig file to use when talking to the cluster
--kubelet-version string
The desired version for the kubelet. Defaults to being autodetected from 'kubelet --version'.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_enable-dynamic.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_enable-dynamic.md new file mode 100644 index 0000000000000..56d653b7fbcf8 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_enable-dynamic.md @@ -0,0 +1,68 @@ + +EXPERIMENTAL: Enables or updates dynamic kubelet configuration for a Node + +### Synopsis + + +Enables or updates dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster, where X is the minor version of the desired kubelet version. + +WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it may have surprising side-effects at this stage. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config enable-dynamic [flags] +``` + +### Examples + +``` + # Enables dynamic kubelet configuration for a Node. + kubeadm alpha phase kubelet enable-dynamic-config --node-name node-1 --kubelet-version v1.11.0 + + WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it + may have surprising side-effects at this stage. +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for enable-dynamic
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--kubelet-version string
The desired version for the kubelet
--node-name string
Name of the node that should enable the dynamic kubelet configuration
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_upload.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_upload.md new file mode 100644 index 0000000000000..eb56fe1d031e8 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_upload.md @@ -0,0 +1,56 @@ + +Uploads kubelet configuration to a ConfigMap based on a kubeadm MasterConfiguration file. + +### Synopsis + + +Uploads kubelet configuration extracted from the kubeadm MasterConfiguration object to a ConfigMap of the form kubelet-config-1.X in the cluster, where X is the minor version of the current (API Server) Kubernetes version. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config upload [flags] +``` + +### Examples + +``` + # Uploads the kubelet configuration from the kubeadm Config file to a ConfigMap in the cluster. + kubeadm alpha phase kubelet config upload --config kubeadm.yaml +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for upload
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_write-to-disk.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_write-to-disk.md new file mode 100644 index 0000000000000..09bcad8394920 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_write-to-disk.md @@ -0,0 +1,49 @@ + +Writes kubelet configuration to disk, either based on the --config argument. + +### Synopsis + + +Writes kubelet configuration to disk, based on the kubeadm configuration passed via "--config". + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config write-to-disk [flags] +``` + +### Examples + +``` + # Extracts the kubelet configuration from a kubeadm configuration file + kubeadm alpha phase kubelet config write-to-disk --config kubeadm.yaml +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for write-to-disk
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_write-env-file.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_write-env-file.md new file mode 100644 index 0000000000000..7dc61eabb92a1 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_write-env-file.md @@ -0,0 +1,52 @@ + +Writes an environment file with runtime flags for the kubelet. + +### Synopsis + + +Writes an environment file with flags that should be passed to the kubelet executing on the master or node. This --config flag can either consume a MasterConfiguration object or a NodeConfiguration one, as this function is used for both "kubeadm init" and "kubeadm join". + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet write-env-file [flags] +``` + +### Examples + +``` + # Writes a dynamic environment file with kubelet flags from a MasterConfiguration file. + kubeadm alpha phase kubelet write-env-file --config masterconfig.yaml + + # Writes a dynamic environment file with kubelet flags from a NodeConfiguration file. + kubeadm alpha phase kubelet write-env-file --config nodeConfig.yaml +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for write-env-file
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md index f1df1a88c6019..9c456dd4838f9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md @@ -24,7 +24,7 @@ kubeadm alpha phase mark-master [flags] ### Options - +
@@ -35,28 +35,28 @@ kubeadm alpha phase mark-master [flags] - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md index 5156b96fd9341..b47c3938c345e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for mark-masterhelp for mark-master
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
--node-name string
The node name to which label and taints should applyThe node name to which label and taints should apply
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md index b42b1bc7c23da..2a84b5a9c30f6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md @@ -21,7 +21,7 @@ kubeadm alpha phase preflight master [flags] ### Options -
-h, --help
help for preflighthelp for preflight
+
@@ -32,7 +32,7 @@ kubeadm alpha phase preflight master [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md index 34a2ee987322d..973c743a4c6ba 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md @@ -21,7 +21,7 @@ kubeadm alpha phase preflight node [flags] ### Options -
-h, --help
help for masterhelp for master
+
@@ -32,7 +32,7 @@ kubeadm alpha phase preflight node [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md index 1815a4afa1a70..85f87530d2062 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
-h, --help
help for nodehelp for node
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md index 548f4a3a42392..76e16d03e07ec 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md @@ -26,7 +26,7 @@ kubeadm alpha phase selfhosting convert-from-staticpods [flags] ### Options -
-h, --help
help for selfhostinghelp for selfhosting
+
@@ -37,35 +37,35 @@ kubeadm alpha phase selfhosting convert-from-staticpods [flags] - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md index 8ba97c89140d7..c9b013f9346b8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md @@ -23,7 +23,7 @@ kubeadm alpha phase upload-config [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for convert-from-staticpodshelp for convert-from-staticpods
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -34,21 +34,21 @@ kubeadm alpha phase upload-config [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md index 392a006cc610e..301a76999bd56 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md @@ -10,16 +10,17 @@ The shell code must be evaluated to provide interactive completion of kubeadm commands. This can be done by sourcing it from the .bash_profile. -Note: this requires the bash-completion framework, which is not installed -by default on Mac. This can be installed by using homebrew: +Note: this requires the bash-completion framework. +To install it on Mac use homebrew: $ brew install bash-completion - Once installed, bash_completion must be evaluated. This can be done by adding the following line to the .bash_profile - $ source $(brew --prefix)/etc/bash_completion +If bash-completion is not installed on Linux, please install the 'bash-completion' package +via your distribution's package manager. + Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 ``` @@ -49,7 +50,7 @@ source <(kubeadm completion zsh) ### Options -
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for upload-confighelp for upload-config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -60,7 +61,7 @@ source <(kubeadm completion zsh) - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md index 97a7460d28f69..54a478a8eaa71 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md @@ -17,7 +17,7 @@ kubeadm config [flags] ### Options -
-h, --help
help for completionhelp for completion
+
@@ -28,14 +28,14 @@ kubeadm config [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md new file mode 100644 index 0000000000000..85f978a88e0ee --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md @@ -0,0 +1,54 @@ + +Interact with container images used by kubeadm. + +### Synopsis + + +Interact with container images used by kubeadm. + +``` +kubeadm config images [flags] +``` + +### Options + +
-h, --help
help for confighelp for config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+ + + + + + + + + + + + + + +
-h, --help
help for images
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md new file mode 100644 index 0000000000000..ca2a2119b5bbd --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md @@ -0,0 +1,75 @@ + +Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized. + +### Synopsis + + +Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized. + +``` +kubeadm config images list [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for list
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md new file mode 100644 index 0000000000000..d5efa5ab05627 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md @@ -0,0 +1,82 @@ + +Pull images used by kubeadm. + +### Synopsis + + +Pull images used by kubeadm. + +``` +kubeadm config images pull [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file.
--cri-socket-path string     Default: "/var/run/dockershim.sock"
Path to the CRI socket.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for pull
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md new file mode 100644 index 0000000000000..2a41580170881 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md @@ -0,0 +1,82 @@ + +Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version. + +### Synopsis + + + +This command lets you convert configuration objects of older versions to the latest supported version, +locally in the CLI tool without ever touching anything in the cluster. +In this version of kubeadm, the following API versions are supported: +- kubeadm.k8s.io/v1alpha2 +- kubeadm.k8s.io/v1alpha1 + +Further, kubeadm can only write out config of version "kubeadm.k8s.io/v1alpha2", but read both types. +So regardless of what version you pass to the --old-config parameter here, the API object will be +read, deserialized, defaulted, converted, validated, and re-serialized when written to stdout or +--new-config if specified. + +In other words, the output of this command is what kubeadm actually would read internally if you +submitted this file to "kubeadm init" + + +``` +kubeadm config migrate [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for migrate
--new-config string
Path to the resulting equivalent kubeadm config file using the new API version. Optional, if not specified output will be sent to STDOUT.
--old-config string
Path to the kubeadm config file that is using an old API version and should be converted. This flag is mandatory.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print-default.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print-default.md new file mode 100644 index 0000000000000..3e011d9743d7b --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print-default.md @@ -0,0 +1,67 @@ + +Print the default values for a kubeadm configuration object. + +### Synopsis + + + +This command prints the default MasterConfiguration object that is used for 'kubeadm init' and 'kubeadm upgrade', +and the default NodeConfiguration object that is used for 'kubeadm join'. + +Note that sensitive values like the Bootstrap Token fields are replaced with silly values like {"abcdef.0123456789abcdef" "" "nil" [] []} in order to pass validation but +not perform the real computation for creating a token. + + +``` +kubeadm config print-default [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + +
--api-objects stringSlice
A comma-separated list for API objects to print the default values for. Available values: [MasterConfiguration NodeConfiguration]. This flag unset means 'print all known objects'
-h, --help
help for print-default
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md index 6b349c6033857..e20d2ca0c720a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md @@ -12,7 +12,7 @@ kubeadm config upload [flags] ### Options - +
@@ -23,7 +23,7 @@ kubeadm config upload [flags] - + @@ -33,7 +33,7 @@ kubeadm config upload [flags] ### Options inherited from parent commands -
-h, --help
help for uploadhelp for upload
+
@@ -44,7 +44,7 @@ kubeadm config upload [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md index ce9ecef53b678..aa2905e2c1a98 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md @@ -18,7 +18,7 @@ kubeadm config upload from-file [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -29,14 +29,14 @@ kubeadm config upload from-file [flags] - + - + @@ -46,7 +46,7 @@ kubeadm config upload from-file [flags] ### Options inherited from parent commands -
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental.Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for from-filehelp for from-file
+
@@ -57,7 +57,7 @@ kubeadm config upload from-file [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md index abae4d531686f..faf57f341f74c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md @@ -18,7 +18,7 @@ kubeadm config upload from-flags [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -29,98 +29,84 @@ kubeadm config upload from-flags [flags] - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - + @@ -130,7 +116,7 @@ kubeadm config upload from-flags [flags] ### Options inherited from parent commands -
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.Port for the API Server to bind to.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.The path where to save and store the certificates.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.Specify the CRI socket to connect to.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for from-flagshelp for from-flags
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.Specify the node name.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
--token string
The token to use for establishing bidirectional trust between nodes and masters.
--token-ttl duration     Default: 24h0m0s
The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.Use alternative domain for services, e.g. "myorg.internal".
+
@@ -141,7 +127,7 @@ kubeadm config upload from-flags [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md index a2ded40f2de10..9869d43c8d131 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md @@ -16,7 +16,7 @@ kubeadm config view [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -27,7 +27,7 @@ kubeadm config view [flags] - + @@ -37,7 +37,7 @@ kubeadm config view [flags] ### Options inherited from parent commands -
-h, --help
help for viewhelp for view
+
@@ -48,7 +48,7 @@ kubeadm config view [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md index d9139f947e91b..b846cf903473d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md @@ -12,7 +12,7 @@ kubeadm init [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -23,126 +23,126 @@ kubeadm init [flags] - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md index 88388b2be40ef..c321fe6af9134 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md @@ -53,7 +53,7 @@ kubeadm join [flags] ### Options -
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.Port for the API Server to bind to.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.The path where to save and store the certificates.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.Specify the CRI socket to connect to.
--dry-run
Don't apply any changes; just output what would be done.Don't apply any changes; just output what would be done.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for inithelp for init
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.Specify the node name.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".Use alternative domain for services, e.g. "myorg.internal".
--skip-token-print
Skip printing of the default bootstrap token generated by 'kubeadm init'.Skip printing of the default bootstrap token generated by 'kubeadm init'.
--token string
The token to use for establishing bidirectional trust between nodes and masters.The token to use for establishing bidirectional trust between nodes and masters. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--token-ttl duration     Default: 24h0m0s
The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
+
@@ -64,84 +64,84 @@ kubeadm join [flags] - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md index 49036f02a3d13..5f5cd9b4be0d7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md @@ -12,7 +12,7 @@ kubeadm reset [flags] ### Options -
--config string
Path to kubeadm config file.Path to kubeadm config file.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.Specify the CRI socket to connect to.
--discovery-file string
A file or url from which to load cluster information.A file or url from which to load cluster information.
--discovery-token string
A token used to validate cluster information fetched from the master.A token used to validate cluster information fetched from the master.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for joinhelp for join
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--node-name string
Specify the node name.Specify the node name.
--tls-bootstrap-token string
A token used for TLS bootstrapping.A token used for TLS bootstrapping.
--token string
Use this token for both discovery-token and tls-bootstrap-token.Use this token for both discovery-token and tls-bootstrap-token.
+
@@ -23,28 +23,35 @@ kubeadm reset [flags] - + - + + + + + + + + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md index a4dfb9a605466..eaddaa1c5a110 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md @@ -29,7 +29,7 @@ kubeadm token [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path to the directory where the certificates are stored. If specified, clean this directory.The path to the directory where the certificates are stored. If specified, clean this directory.
--cri-socket string     Default: "/var/run/dockershim.sock"
The path to the CRI socket to use with crictl when cleaning up containers.The path to the CRI socket to use with crictl when cleaning up containers.
--force
Reset the node without prompting for confirmation.
-h, --help
help for resethelp for reset
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
+
@@ -40,21 +40,21 @@ kubeadm token [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md index f2622eae9852e..15116185ac9ce 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md @@ -19,7 +19,7 @@ kubeadm token create [token] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
-h, --help
help for tokenhelp for token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -30,49 +30,49 @@ kubeadm token create [token] - + - + - + - + - + - + - + - + @@ -82,7 +82,7 @@ kubeadm token create [token] ### Options inherited from parent commands -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--description string
A human friendly description of how this token is used.A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]".Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-h, --help
help for createhelp for create
--print-join-command
Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token.Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token.
--ttl duration     Default: 24h0m0s--token-ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire.The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication].Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]
+
@@ -93,14 +93,14 @@ kubeadm token create [token] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md index 8a3c1b1624740..8a47b4345dba9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md @@ -17,7 +17,7 @@ kubeadm token delete [token-value] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -28,7 +28,7 @@ kubeadm token delete [token-value] - + @@ -38,7 +38,7 @@ kubeadm token delete [token-value] ### Options inherited from parent commands -
-h, --help
help for deletehelp for delete
+
@@ -49,14 +49,14 @@ kubeadm token delete [token-value] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md index 35c70727fde15..f76a8d9d1a478 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md @@ -22,7 +22,7 @@ kubeadm token generate [flags] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -33,7 +33,7 @@ kubeadm token generate [flags] - + @@ -43,7 +43,7 @@ kubeadm token generate [flags] ### Options inherited from parent commands -
-h, --help
help for generatehelp for generate
+
@@ -54,14 +54,14 @@ kubeadm token generate [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md index dd1726026bf54..a65b730a28c33 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md @@ -14,7 +14,7 @@ kubeadm token list [flags] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -25,7 +25,7 @@ kubeadm token list [flags] - + @@ -35,7 +35,7 @@ kubeadm token list [flags] ### Options inherited from parent commands -
-h, --help
help for listhelp for list
+
@@ -46,14 +46,14 @@ kubeadm token list [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md index 5c6ba4673d4c6..8bd79242839a8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md @@ -12,7 +12,7 @@ kubeadm upgrade [flags] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -23,56 +23,56 @@ kubeadm upgrade [flags] - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md index df44de32d6744..15ae2a283e7ec 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md @@ -12,7 +12,7 @@ kubeadm upgrade apply [version] ### Options -
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for upgradehelp for upgrade
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+
@@ -23,42 +23,42 @@ kubeadm upgrade apply [version] - + - + - + - + - + - + @@ -68,7 +68,7 @@ kubeadm upgrade apply [version] ### Options inherited from parent commands -
--dry-run
Do not change any state, just output what actions would be performed.Do not change any state, just output what actions would be performed.
--etcd-upgrade     Default: true
Perform the upgrade of etcd.Perform the upgrade of etcd.
-f, --force
Force upgrading although some requirements might not be met. This also implies non-interactive mode.Force upgrading although some requirements might not be met. This also implies non-interactive mode.
-h, --help
help for applyhelp for apply
--image-pull-timeout duration     Default: 15m0s
The maximum amount of time to wait for the control plane pods to be downloaded.The maximum amount of time to wait for the control plane pods to be downloaded.
-y, --yes
Perform the upgrade and do not prompt for confirmation (non-interactive mode).Perform the upgrade and do not prompt for confirmation (non-interactive mode).
+
@@ -79,49 +79,49 @@ kubeadm upgrade apply [version] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md new file mode 100644 index 0000000000000..64053f17fc07d --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md @@ -0,0 +1,124 @@ + +Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run + +### Synopsis + + +Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run + +``` +kubeadm upgrade diff [version] [flags] +``` + +### Options + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--api-server-manifest string     Default: "/etc/kubernetes/manifests/kube-apiserver.yaml"
path to API server manifest
-c, --context-lines int     Default: 3
How many lines of context in the diff
--controller-manager-manifest string     Default: "/etc/kubernetes/manifests/kube-controller-manager.yaml"
path to controller manifest
-h, --help
help for diff
--scheduler-manifest string     Default: "/etc/kubernetes/manifests/kube-scheduler.yaml"
path to scheduler manifest
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md new file mode 100644 index 0000000000000..037a07e56bee7 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md @@ -0,0 +1,96 @@ + +Upgrade commands for a node in the cluster. Currently only supports upgrading the configuration, not the kubelet itself. + +### Synopsis + + +Upgrade commands for a node in the cluster. Currently only supports upgrading the configuration, not the kubelet itself. + +``` +kubeadm upgrade node [flags] +``` + +### Options + + + + + + + + + + + + + + + + +
-h, --help
help for node
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md new file mode 100644 index 0000000000000..3172348328c12 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md @@ -0,0 +1,121 @@ + +Downloads the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet. + +### Synopsis + + +Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. kubeadm uses the --kubelet-version parameter to determine what the desired kubelet version is. Give + +``` +kubeadm upgrade node config [flags] +``` + +### Examples + +``` + # Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version. + kubeadm upgrade node config --kubelet-version v1.11.0 + + # Simulates the downloading of the kubelet configuration from the ConfigMap in the cluster with a specific desired + # version. Does not change any state locally on the node. + kubeadm upgrade node config --kubelet-version v1.11.0 --dry-run +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Do not change any state, just output the actions that would be performed.
-h, --help
help for config
--kubelet-version string
The *desired* version for the kubelet after the upgrade.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md index 55bff85193739..23e42a640141b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md @@ -1,18 +1,18 @@ -Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. +Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter. ### Synopsis -Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. +Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter. ``` -kubeadm upgrade plan [flags] +kubeadm upgrade plan [version] [flags] ``` ### Options - +
@@ -23,7 +23,7 @@ kubeadm upgrade plan [flags] - + @@ -33,7 +33,7 @@ kubeadm upgrade plan [flags] ### Options inherited from parent commands -
-h, --help
help for planhelp for plan
+
@@ -44,49 +44,49 @@ kubeadm upgrade plan [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md index 52cbb40aa48f5..9d47c24691647 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md @@ -12,7 +12,7 @@ kubeadm version [flags] ### Options -
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+
@@ -23,14 +23,14 @@ kubeadm version [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md b/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md index 38dc52bfb37b6..9059248ce067d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md +++ b/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md @@ -28,7 +28,7 @@ The cluster that `kubeadm init` and `kubeadm join` set up should be: - using secure communication between the control plane components - using secure communication between the API server and the kubelets - lock-down the kubelet API - - locking down access to the API for system components like the kube-proxy and kube-dns + - locking down access to the API for system components like the kube-proxy and CoreDNS - locking down what a Bootstrap Token can access - etc. - **Easy to use**: The user should not have to run anything more than a couple of commands: @@ -451,16 +451,20 @@ A ServiceAccount for `kube-proxy` is created in the `kube-system` namespace; the #### DNS -A ServiceAccount for `kube-dns` is created in the `kube-system` namespace. +Note that: -Deploy the kube-dns Deployment and Service: +- The CoreDNS service is named `kube-dns`. This is done to prevent any interruption +in service when the user is switching the cluster DNS from kube-dns to CoreDNS or vice-versa +- In Kubernetes version 1.11 and later, CoreDNS is the default DNS server and you must +invoke kubeadm with `--feature-gates=CoreDNS=false` to install kube-dns instead +- In Kubernetes version 1.10 and earlier, you must enable CoreDNS with `--feature-gates=CoreDNS=true` -- It's the upstream kube-dns deployment relatively unmodified -- The `kube-dns` ServiceAccount is bound to the privileges in the `system:kube-dns` ClusterRole +A ServiceAccount for CoreDNS/kube-dns is created in the `kube-system` namespace. -Please note that: +Deploy the `kube-dns` Deployment and Service: -1. If kubeadm is invoked with `--feature-gates=CoreDNS`, CoreDNS is installed instead of `kube-dns` +- It's the upstream CoreDNS deployment relatively unmodified +- The `kube-dns` ServiceAccount is bound to the privileges in the `system:kube-dns` ClusterRole ### (Optional and alpha in v1.9) self-hosting diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md index aaa16e1ef5944..ae8afd71dff1a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md @@ -118,12 +118,14 @@ Alternatively, you can use [kubeadm config](/docs/reference/setup-tools/kubeadm/ You can install all the available addons with the `all` subcommand, or install them selectively. -Please note that if kubeadm is invoked with `--feature-gates=CoreDNS=true`, [CoreDNS](https://coredns.io/) is installed instead of `kube-dns`. +{{< note >}} +**Note:** If `kubeadm` is invoked with `--feature-gates=CoreDNS=false`, kube-dns is installed. +{{< /note >}} {{< tabs name="tab-addon" >}} {{< tab name="all" include="generated/kubeadm_alpha_phase_addon_all.md" />}} {{< tab name="kube-proxy" include="generated/kubeadm_alpha_phase_addon_kube-proxy.md" />}} -{{< tab name="kube-dns" include="generated/kubeadm_alpha_phase_addon_kube-dns.md" />}} +{{< tab name="coredns" include="generated/kubeadm_alpha_phase_addon_coredns.md" />}} {{< /tabs >}} diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md index 3d095830c36df..b5e9a19f9315d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md @@ -16,6 +16,11 @@ You can execute `kubeadm config view` to view the ConfigMap. If you initialized kubeadm v1.7.x or lower, you must use `kubeadm config upload` to create the ConfigMap before you may use `kubeadm upgrade`. +In Kubernetes v1.11.0, some new commands were added. You can use `kubeadm config print-default` +to print the default configuration and `kubeadm config migrate` to convert your old configuration +files to a newer version. `kubeadm config images list` and `kubeadm config images pull` can be used +to list and pull the images that kubeadm requires. + {{% /capture %}} {{% capture body %}} @@ -27,6 +32,19 @@ may use `kubeadm upgrade`. ## kubeadm config view {#cmd-config-view} {{< include "generated/kubeadm_config_view.md" >}} + +## kubeadm config print-default {#cmd-config-print-default} +{{< include "generated/kubeadm_config_print-default.md" >}} + +## kubeadm config migrate {#cmd-config-migrate} +{{< include "generated/kubeadm_config_migrate.md" >}} + +## kubeadm config images list {#cmd-config-images-list} +{{< include "generated/kubeadm_config_images_list.md" >}} + +## kubeadm config images pull {#cmd-config-images-pull} +{{< include "generated/kubeadm_config_images_pull.md" >}} + {{% /capture %}} {{% capture whatsnext %}} diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md index 9639fb39a7860..a9fdedd005611 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md @@ -29,6 +29,7 @@ following steps: own CA cert and/or key by dropping it in the cert directory configured via `--cert-dir` (`/etc/kubernetes/pki` by default) this step is skipped as described in the [Using custom certificates](#custom-certificates) document. + The APIServer certs will have additional SAN entries for any `--apiserver-cert-extra-sans` arguments, lowercased if necessary. 1. Writes kubeconfig files in `/etc/kubernetes/` for the kubelet, the controller-manager and the scheduler to use to connect to the @@ -79,14 +80,15 @@ following steps: See [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) for additional info. -1. Installs the internal DNS server (kube-dns) and the kube-proxy addon components via the API server. If kubeadm is invoked with `--feature-gates=CoreDNS=true`, then [CoreDNS](https://coredns.io/) will be installed as the default internal DNS server instead of kube-dns. +1. Installs a DNS server (CoreDNS) and the kube-proxy addon components via the API server. + In Kubernetes version 1.11 and later CoreDNS is the default DNS server. + To install kube-dns instead of CoreDNS, kubeadm must be invoked with `--feature-gates=CoreDNS=false`. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. 1. If `kubeadm init` is invoked with the alpha self-hosting feature enabled, (`--feature-gates=SelfHosting=true`), the static Pod based control plane is transformed into a [self-hosted control plane](#self-hosting). - ### Using kubeadm init with a configuration file {#config-file} {{< caution >}} @@ -96,81 +98,160 @@ still considered alpha and may change in future versions. It's possible to configure `kubeadm init` with a configuration file instead of command line flags, and some more advanced features may only be available as -configuration file options. This file is passed in the `--config` option. +configuration file options. This file is passed in the `--config` option. + +In Kubernetes 1.11 and later, the default configuration can be printed out using the +[kubeadm config print-default](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command. + +For more details on each field in the configuration you can navigate to our +[API reference pages.] (https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#MasterConfiguration) + +Example of the kubeadm MasterConfiguration version `v1alpha2`: ```yaml -apiVersion: kubeadm.k8s.io/v1alpha1 +apiVersion: kubeadm.k8s.io/v1alpha2 kind: MasterConfiguration +kubernetesVersion: v1.11.0 api: - advertiseAddress: - controlPlaneEndpoint: - bindPort: + advertiseAddress: 192.168.0.102 + bindPort: 6443 + controlPlaneEndpoint: "" +auditPolicy: + logDir: /var/log/kubernetes/audit + logMaxAge: 2 + path: "" +bootstrapTokens: +- groups: + - system:bootstrappers:kubeadm:default-node-token + token: abcdef.0123456789abcdef + ttl: 24h0m0s + usages: + - signing + - authentication +certificatesDir: /etc/kubernetes/pki +clusterName: kubernetes etcd: - endpoints: - - - - - caFile: - certFile: - keyFile: - dataDir: - extraArgs: - : - : - image: - serverCertSANs: - - - - - peerCertSANs: - - - - + local: + dataDir: /var/lib/etcd + image: "" +imageRepository: k8s.gcr.io kubeProxy: config: - mode: - bindAddress: - clusterCIDR: + bindAddress: 0.0.0.0 + clientConnection: + acceptContentTypes: "" + burst: 10 + contentType: application/vnd.kubernetes.protobuf + kubeconfig: /var/lib/kube-proxy/kubeconfig.conf + qps: 5 + clusterCIDR: "" + configSyncPeriod: 15m0s + conntrack: + max: null + maxPerCore: 32768 + min: 131072 + tcpCloseWaitTimeout: 1h0m0s + tcpEstablishedTimeout: 24h0m0s + enableProfiling: false + healthzBindAddress: 0.0.0.0:10256 + hostnameOverride: "" + iptables: + masqueradeAll: false + masqueradeBit: 14 + minSyncPeriod: 0s + syncPeriod: 30s + ipvs: + ExcludeCIDRs: null + minSyncPeriod: 0s + scheduler: "" + syncPeriod: 30s + metricsBindAddress: 127.0.0.1:10249 + mode: "" + nodePortAddresses: null + oomScoreAdj: -999 + portRange: "" + resourceContainer: /kube-proxy + udpIdleTimeout: 250ms +kubeletConfiguration: + baseConfig: + address: 0.0.0.0 + authentication: + anonymous: + enabled: false + webhook: + cacheTTL: 2m0s + enabled: true + x509: + clientCAFile: /etc/kubernetes/pki/ca.crt + authorization: + mode: Webhook + webhook: + cacheAuthorizedTTL: 5m0s + cacheUnauthorizedTTL: 30s + cgroupDriver: cgroupfs + cgroupsPerQOS: true + clusterDNS: + - 10.96.0.10 + clusterDomain: cluster.local + containerLogMaxFiles: 5 + containerLogMaxSize: 10Mi + contentType: application/vnd.kubernetes.protobuf + cpuCFSQuota: true + cpuManagerPolicy: none + cpuManagerReconcilePeriod: 10s + enableControllerAttachDetach: true + enableDebuggingHandlers: true + enforceNodeAllocatable: + - pods + eventBurst: 10 + eventRecordQPS: 5 + evictionHard: + imagefs.available: 15% + memory.available: 100Mi + nodefs.available: 10% + nodefs.inodesFree: 5% + evictionPressureTransitionPeriod: 5m0s + failSwapOn: true + fileCheckFrequency: 20s + hairpinMode: promiscuous-bridge + healthzBindAddress: 127.0.0.1 + healthzPort: 10248 + httpCheckFrequency: 20s + imageGCHighThresholdPercent: 85 + imageGCLowThresholdPercent: 80 + imageMinimumGCAge: 2m0s + iptablesDropBit: 15 + iptablesMasqueradeBit: 14 + kubeAPIBurst: 10 + kubeAPIQPS: 5 + makeIPTablesUtilChains: true + maxOpenFiles: 1000000 + maxPods: 110 + nodeStatusUpdateFrequency: 10s + oomScoreAdj: -999 + podPidsLimit: -1 + port: 10250 + registryBurst: 10 + registryPullQPS: 5 + resolvConf: /etc/resolv.conf + rotateCertificates: true + runtimeRequestTimeout: 2m0s + serializeImagePulls: true + staticPodPath: /etc/kubernetes/manifests + streamingConnectionIdleTimeout: 4h0m0s + syncFrequency: 1m0s + volumeStatsAggPeriod: 1m0s networking: - dnsDomain: - serviceSubnet: - podSubnet: -kubernetesVersion: -cloudProvider: -nodeName: -authorizationModes: -- -- -token: -tokenTTL:
-h, --help
help for versionhelp for version
-o, --output string
Output format; available options are 'yaml', 'json' and 'short'Output format; available options are 'yaml', 'json' and 'short'
- -
- - - + + - - - + + - - - + + - - - + + - - - + + - - - + + + + + +
Possible MessagesPossible ReasonsStatusError MessagePossible Causes

using current: local

when the config source is nil, the Kubelet uses its local config

True

failed to load config, see Kubelet log for details

The Kubelet likely could not parse the downloaded config payload, or encountered a filesystem error attempting to load the payload from disk.

using current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}

passing all checks

True

failed to validate config, see Kubelet log for details

The configuration in the payload, combined with any command-line flag overrides, and the sum of feature gates from flags, the config file, and the remote payload, was determined to be invalid by the Kubelet.

using last-known-good: local

 -
    -
  • failed to load current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to parse current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to validate current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
-

False

invalid NodeConfigSource, exactly one subfield must be non-nil, but all were nil

Since Node.Spec.ConfigSource is validated by the API server to contain at least one non-nil subfield, this likely means that the Kubelet is older than the API server and does not recognize a newer source type.

using last-known-good: /api/v1/namespaces/${LAST_KNOWN_GOOD_CONFIG_MAP_NAMESPACE}/configmaps/${LAST_KNOWN_GOOD_CONFIG_MAP_NAME}

 -
    -
  • failed to load current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to parse current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to validate current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
-

False

failed to sync: failed to download config, see Kubelet log for details

The Kubelet could not download the config. It is possible that Node.Spec.ConfigSource could not be resolved to a concrete API object, or that network errors disrupted the download attempt. The Kubelet will retry the download when in this error state.
-

- The reasons in the next column could potentially appear for any of - the above messages. -

-

- This condition indicates that the Kubelet is having trouble - reconciling `spec.configSource`, and thus no change to the in-use - configuration has occurred. -

-

- The "failed to sync" reasons are specific to the failure that - occurred, and the next column does not necessarily contain all - possible failure reasons. -

- 		-

failed to sync, reason:

-
    -
  • failed to read Node from informer object cache
    • -
  • failed to reset to local config
    • -
  • invalid NodeConfigSource, exactly one subfield must be non-nil, but all were nil
    • -
  • invalid ObjectReference, all of UID, Name, and Namespace must be specified
    • -
  • invalid ConfigSource.ConfigMapRef.UID: ${UID} does not match ${API_PATH}.UID: ${UID_OF_CONFIG_MAP_AT_API_PATH}
    • -
  • failed to determine whether object ${API_PATH} with UID ${UID} was already checkpointed
    • -
  • failed to download ConfigMap with name ${NAME} from namespace ${NAMESPACE}
    • -
  • failed to save config checkpoint for object ${API_PATH} with UID ${UID}
    • -
  • failed to set current config checkpoint to local config
    • -
  • failed to set current config checkpoint to object ${API_PATH} with UID ${UID}
    • -
-

False

failed to sync: internal failure, see Kubelet log for details

The Kubelet encountered some internal problem and failed to update its config as a result. Examples include filesystem errors and reading objects from the internal informer cache.

internal failure, see Kubelet log for details

The Kubelet encountered some internal problem while manipulating config, outside of the configuration sync loop.
-{{% /capture %}} - - +{{% /capture %}} diff --git a/content/en/docs/tasks/administer-cluster/running-cloud-controller.md b/content/en/docs/tasks/administer-cluster/running-cloud-controller.md index f79be347f83a5..0e5901ffc8382 100644 --- a/content/en/docs/tasks/administer-cluster/running-cloud-controller.md +++ b/content/en/docs/tasks/administer-cluster/running-cloud-controller.md @@ -6,7 +6,7 @@ reviewers: title: Kubernetes Cloud Controller Manager --- -{{< feature-state state="alpha" >}} +{{< feature-state state="beta" >}} {{< toc >}} @@ -32,7 +32,8 @@ Successfully running cloud-controller-manager requires some changes to your clus * `kube-apiserver` and `kube-controller-manager` MUST NOT specify the `--cloud-provider` flag. This ensures that it does not run any cloud specific loops that would be run by cloud controller manager. In the future, this flag will be deprecated and removed. * `kubelet` must run with `--cloud-provider=external`. This is to ensure that the kubelet is aware that it must be initialized by the cloud controller manager before it is scheduled any work. -* `kube-apiserver` SHOULD NOT run the `PersistentVolumeLabel` admission controller since the cloud controller manager takes over labeling persistent volumes. To prevent the PersistentVolumeLabel admission plugin from running in `kube-apiserver`, include the `PersistentVolumeLabel` as a listed value in the `--disable-admission-plugins` flag. +* `kube-apiserver` SHOULD NOT run the `PersistentVolumeLabel` admission controller + since the cloud controller manager takes over labeling persistent volumes. * For the `cloud-controller-manager` to label persistent volumes, initializers will need to be enabled and an InitializerConifguration needs to be added to the system. Follow [these instructions](/docs/admin/extensible-admission-controllers.md#enable-initializers-alpha-feature) to enable initializers. Use the following YAML to create the InitializerConfiguration: {{< code file="persistent-volume-label-initializer-config.yaml" >}} @@ -48,7 +49,7 @@ As of v1.8, cloud controller manager can implement: * node controller - responsible for updating kubernetes nodes using cloud APIs and deleting kubernetes nodes that were deleted on your cloud. * service controller - responsible for loadbalancers on your cloud against services of type LoadBalancer. * route controller - responsible for setting up network routes on your cloud -* [PersistentVolumeLabel Admission Controller](/docs/admin/admission-controllers#persistentvolumelabel) - responsible for labeling persistent volumes on your cloud - ensure that the persistent volume label admission plugin is not enabled on your kube-apiserver. +* persistent valume labels controller - responsible for setting the zone and region labels on PersistentVolumes created in GCP and AWS clouds. * any other features you would like to implement if you are running an out-of-tree provider. diff --git a/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md b/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md index ae67d40387592..d5e90dd3497b6 100644 --- a/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md +++ b/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md @@ -7,15 +7,16 @@ content_template: templates/task --- {{% capture overview %}} -{{< feature-state for_k8s_version="v1.10" state="beta" >}} -Persistent volume claims (PVCs) that are in active use by a pod and persistent volumes (PVs) that are bound to PVCs can be protected from pre-mature removal. +Persistent volume claims (PVCs) that are in active use by a pod and persistent volumes (PVs) that are bound to PVCs can be protected from premature removal. {{% /capture %}} {{% capture prerequisites %}} -- The Storage Object in Use Protection feature is enabled in a version of Kubernetes in which it is supported. +The Storage Object in Use Protection feature is enabled in one of the below Kubernetes versions: +- {% assign for_k8s_version = "1.10" %} {% include feature-state-beta.md %} +- {% assign for_k8s_version = "1.11" %} {% include feature-state-stable.md %} {{% /capture %}} @@ -312,5 +313,3 @@ No resources found. {{% /capture %}} - - diff --git a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md index 8ea3e4a30e3f0..3b3d53628e5d1 100644 --- a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md +++ b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md @@ -1,13 +1,15 @@ --- -title: Using Sysctls in a Kubernetes Cluster +title: Using sysctls in a Kubernetes Cluster reviewers: - sttts content_template: templates/task --- {{% capture overview %}} +{{< feature-state for_k8s_version="v1.11" state="beta" >}} -This document describes how sysctls are used within a Kubernetes cluster. +This document describes how to configure and use kernel parameters within a +Kubernetes cluster using the sysctl interface. {{% /capture %}} @@ -74,7 +76,7 @@ application tuning. _Unsafe_ sysctls are enabled on a node-by-node basis with a flag of the kubelet, e.g.: ```shell -$ kubelet --experimental-allowed-unsafe-sysctls \ +$ kubelet --allowed-unsafe-sysctls \ 'kernel.msg*,net.ipv4.route.min_pmtu' ... ``` @@ -89,10 +91,11 @@ Only _namespaced_ sysctls can be enabled this way. ## Setting Sysctls for a Pod A number of sysctls are _namespaced_ in today's Linux kernels. This means that -they can be set independently for each pod on a node. Being namespaced is a -requirement for sysctls to be accessible in a pod context within Kubernetes. +they can be set independently for each pod on a node. Only namespaced sysctls +are configurable via the pod securityContext within Kubernetes. -The following sysctls are known to be _namespaced_: +The following sysctls are known to be namespaced. This list could change +in future versions of the Linux kernel. - `kernel.shm*`, - `kernel.msg*`, @@ -100,25 +103,37 @@ The following sysctls are known to be _namespaced_: - `fs.mqueue.*`, - `net.*`. -Sysctls which are not namespaced are called _node-level_ and must be set -manually by the cluster admin, either by means of the underlying Linux -distribution of the nodes (e.g. via `/etc/sysctls.conf`) or using a DaemonSet -with privileged containers. +Sysctls with no namespace are called _node-level_ sysctls. If you need to set +them, you must manually configure them on each node's operating system, or by +using a DaemonSet with privileged containers. -The sysctl feature is an alpha API. Therefore, sysctls are set using annotations -on pods. They apply to all containers in the same pod. +Use the pod securityContext to configure namespaced sysctls. The securityContext +applies to all containers in the same pod. -Here is an example, with different annotations for _safe_ and _unsafe_ sysctls: +This example uses the pod securityContext to set a safe sysctl +`kernel.shm_rmid_forced` and two unsafe sysctls `net.ipv4.route.min_pmtu` and +`kernel.msgmax` There is no distinction between _safe_ and _unsafe_ sysctls in +the specification. + +{{< warning >}} +Only modify sysctl parameters after you understand their effects, to avoid +destabilizing your operating system. +{{< /warning >}} ```yaml apiVersion: v1 kind: Pod metadata: name: sysctl-example - annotations: - security.alpha.kubernetes.io/sysctls: kernel.shm_rmid_forced=1 - security.alpha.kubernetes.io/unsafe-sysctls: net.ipv4.route.min_pmtu=1000,kernel.msgmax=1 2 3 spec: + securityContext: + sysctls: + - name: kernel.shm_rmid_forced + value: "0" + - name: net.ipv4.route.min_pmtu + value: "552" + - name: kernel.msgmax + value: "65536" ... ``` {{% /capture %}} @@ -143,27 +158,52 @@ is recommended to use [taints on nodes](/docs/concepts/configuration/taint-and-toleration/) to schedule those pods onto the right nodes. -## PodSecurityPolicy Annotations +## PodSecurityPolicy + +You can further control which sysctls can be set in pods by specifying lists of +sysctls or sysctl patterns in the `forbiddenSysctls` and/or +`allowedUnsafeSysctls` fields of the PodSecurityPolicy. A sysctl pattern ends +with a `*` character, such as `kernel.*`. A `*` character on its own matches +all sysctls. + +By default, all safe sysctls are allowed. + +Both `forbiddenSysctls` and `allowedUnsafeSysctls` are lists of plain sysctl names +or sysctl patterns (which end with `*`). The string `*` matches all sysctls. -The use of sysctl in pods can be controlled via annotation on the PodSecurityPolicy. +The `forbiddenSysctls` field excludes specific sysctls. You can forbid a +combination of safe and unsafe sysctls in the list. To forbid setting any +sysctls, use `*` on its own. -Sysctl annotation represents a whitelist of allowed safe and unsafe sysctls -in a pod spec. It's a comma-separated list of plain sysctl names or sysctl patterns -(which end in `*`). The string `*` matches all sysctls. +If you specify any unsafe sysctl in the `allowedUnsafeSysctls` field and it is +not present in the `forbiddenSysctls` field, that sysctl can be used in Pods +using this PodSecurityPolicy. To allow all unsafe sysctls in the +PodSecurityPolicy to be set, use `*` on its own. -Here is an example, it authorizes binding user creating pod with corresponding sysctls. +Do not configure these two fields such that there is overlap, meaning that a +given sysctl is both allowed and forbidden. + +{{< warning >}} +**Warning**: If you whitelist unsafe sysctls via the `allowedUnsafeSysctls` field +in a PodSecurityPolicy, any pod using such a sysctl will fail to start +if the sysctl is not whitelisted via the `--allowed-unsafe-sysctls` kubelet +flag as well on that node. +{{< /warning >}} + +This example allows unsafe sysctls prefixed with `kernel.msg` to be set and +disallows setting of the `kernel.shm_rmid_forced` sysctl. ```yaml apiVersion: policy/v1beta1 kind: PodSecurityPolicy metadata: name: sysctl-psp - annotations: - security.alpha.kubernetes.io/sysctls: 'net.ipv4.route.*,kernel.msg*' spec: + allowedUnsafeSysctls: + - kernel.msg* + forbiddenSysctls: + - kernel.shm_rmid_forced ... ``` {{% /capture %}} - - diff --git a/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md b/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md index 8a6eebb01a932..e5abfb736d9dc 100644 --- a/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md +++ b/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md @@ -20,28 +20,32 @@ but is not allowed to use more CPU than its limit. Each node in your cluster must have at least 1 cpu. -A few of the steps on this page require that the -[Heapster](https://github.com/kubernetes/heapster) service is running -in your cluster. But if you don't have Heapster running, you can do most -of the steps, and it won't be a problem if you skip the Heapster steps. +A few of the steps on this page require you to run the +[metrics-server](https://github.com/kubernetes-incubator/metrics-server) +service in your cluster. If you don't have metrics-server +running, you can skip those steps. -If you are running minikube, run the following command to enable heapster: +If you are running minikube, run the following command to enable +metrics-server: ```shell -minikube addons enable heapster +minikube addons enable metrics-server ``` -To see whether the Heapster service is running, enter this command: +To see whether metrics-server (or another provider of the resource metrics +API, `metrics.k8s.io`) is running, enter this command: ```shell -kubectl get services --namespace=kube-system +kubectl get apiservices ``` -If the heapster service is running, it shows in the output: +If the resource metrics API is available, the output will include a +reference to `metrics.k8s.io`. + ```shell -NAMESPACE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE -kube-system heapster 10.11.240.9 80/TCP 6d +NAME +v1beta1.metrics.k8s.io ``` {{% /capture %}} @@ -101,26 +105,18 @@ resources: cpu: 500m ``` -Start a proxy so that you can call the heapster service: +Use `kubectl top` to fetch the metrics for the pod: ```shell -kubectl proxy -``` - -In another command window, get the CPU usage rate from the heapster service: - -``` -curl http://localhost:8001/api/v1/namespaces/kube-system/services/heapster/proxy/api/v1/model/namespaces/cpu-example/pods/cpu-demo/metrics/cpu/usage_rate +kubectl top pod memory-demo ``` The output shows that the Pod is using 974 millicpu, which is just a bit less than the limit of 1 cpu specified in the Pod's configuration file. -```json -{ - "timestamp": "2017-06-22T18:48:00Z", - "value": 974 -} +``` +NAME CPU(cores) MEMORY(bytes) +memory-demo 794m ``` Recall that by setting `-cpu "2"`, you configured the Container to attempt to use 2 cpus. diff --git a/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md b/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md index 451e2123f511e..6120b3a4601ed 100644 --- a/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md +++ b/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md @@ -19,28 +19,33 @@ but is not allowed to use more memory than its limit. Each node in your cluster must have at least 300 MiB of memory. -A few of the steps on this page require that the -[Heapster](https://github.com/kubernetes/heapster) service is running -in your cluster. But if you don't have Heapster running, you can do most -of the steps, and it won't be a problem if you skip the Heapster steps. +A few of the steps on this page require you to run the +[metrics-server](https://github.com/kubernetes-incubator/metrics-server) +service in your cluster. If you don't have metrics-server ++running, you can skip those steps. -If you are running minikube, run the following command to enable heapster: +If you are running minikube, run the following command to enable +metrics-server: ```shell -minikube addons enable heapster +minikube addons enable metrics-server ``` -To see whether the Heapster service is running, enter this command: +To see whether metrics-server (or another provider of the resource metrics +API, `metrics.k8s.io`) is running, enter this command: ```shell -kubectl get services --namespace=kube-system +kubectl get apiservices ``` -If the Heapster service is running, it shows in the output: +If the resource metrics API is available, the output will include a +reference to `metrics.k8s.io`. + + ```shell -NAMESPACE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE -kube-system heapster 10.11.240.9 80/TCP 6d +NAME +v1beta1.metrics.k8s.io ``` {{% /capture %}} @@ -103,29 +108,20 @@ resources: ... ``` -Start a proxy so that you can call the Heapster service: +Use `kubectl top` to fetch the metrics for the pod: ```shell -kubectl proxy -``` - -In another command window, get the memory usage from the Heapster service: - -``` -curl http://localhost:8001/api/v1/namespaces/kube-system/services/heapster/proxy/api/v1/model/namespaces/mem-example/pods/memory-demo/metrics/memory/usage +kubectl top pod memory-demo ``` The output shows that the Pod is using about 162,900,000 bytes of memory, which is about 150 MiB. This is greater than the Pod's 100 MiB request, but within the Pod's 200 MiB limit. -```json -{ - "timestamp": "2017-06-20T18:54:00Z", - "value": 162856960 -} ``` - +NAME CPU(cores) MEMORY(bytes) +memory-demo 162856960 +``` Delete your Pod: diff --git a/content/en/docs/tasks/debug-application-cluster/crictl.md b/content/en/docs/tasks/debug-application-cluster/crictl.md new file mode 100644 index 0000000000000..53874f40a722d --- /dev/null +++ b/content/en/docs/tasks/debug-application-cluster/crictl.md @@ -0,0 +1,326 @@ +--- +reviewers: +- Random-Liu +- feiskyer +- mrunalp +title: Debugging Kubernetes nodes with crictl +content_template: templates/task +--- + +{{< toc >}} + +{{% capture overview %}} + +{{< feature-state for_k8s_version="v1.11" state="stable" >}} + +`crictl` is a command-line interface for CRI-compatible container runtimes. +You can use it to inspect and debug container runtimes and applications on a +Kubernetes node. `crictl` and its source are hosted in the +[cri-tools](https://github.com/kubernetes-incubator/cri-tools) repository. + +{{% /capture %}} + +{{% capture prerequisites %}} + +`crictl` requires a Linux operating system with a CRI runtime. + +{{% /capture %}} + +{{% capture steps %}} + +## Installing crictl + +You can download a compressed archive `crictl` from the cri-tools [release +page](https://github.com/kubernetes-incubator/cri-tools/releases), for several +different architectures. Download the version that corresponds to your version +of Kubernetes. Extract it and move it to a location on your system path, such as +`/usr/local/bin/`. + +## General usage + +The `crictl` command has several subcommands and runtime flags. Use +`crictl help` or `crictl help` for more details. + +`crictl` connects to `unix:///var/run/dockershim.sock` by default. For other +runtimes, you can set the endpoint in multiple different ways: + +- By setting flags `--runtime-endpoint` and `--image-endpoint` +- By setting environment variables `CONTAINER_RUNTIME_ENDPOINT` and `IMAGE_SERVICE_ENDPOINT` +- By setting the endpoint in the config file `--config=/etc/crictl.yaml` + +You can also specify timeout values when connecting to the server and enable or +disable debugging, by specifying `timeout` or `debug` values in the configuration +file or using the `--timeout` and `--debug` command-line flags. + +To view or edit the current configuration, view or edit the contents of +`/etc/crictl.yaml`. + +```sh +$ cat /etc/crictl.yaml +runtime-endpoint: unix:///var/run/dockershim.sock +image-endpoint: unix:///var/run/dockershim.sock +timeout: 10 +debug: true +``` + +## Example crictl commands + +The following examples show some `crictl` commands and and example output. + +{{< warning >}} +If you use `crictl` to create pod sandboxes or containers on a running +Kubernetes cluster, the Kubelet will eventually delete them. `crictl` is not a +general purpose workflow tool, but a tool that is useful for debugging. +{{< /warning >}} + +### List pods + +List all pods: + +```bash +crictl pods +``` +```none +POD ID CREATED STATE NAME NAMESPACE ATTEMPT +926f1b5a1d33a About a minute ago Ready sh-84d7dcf559-4r2gq default 0 +4dccb216c4adb About a minute ago Ready nginx-65899c769f-wv2gp default 0 +a86316e96fa89 17 hours ago Ready kube-proxy-gblk4 kube-system 0 +919630b8f81f1 17 hours ago Ready nvidia-device-plugin-zgbbv kube-system 0 +``` + +List pods by name: + +```bash +crictl pods --name nginx-65899c769f-wv2gp +``` +```none +POD ID CREATED STATE NAME NAMESPACE ATTEMPT +4dccb216c4adb 2 minutes ago Ready nginx-65899c769f-wv2gp default 0 +``` + +List pods by label: + +```bash +crictl pods --label run=nginx +``` +```none +POD ID CREATED STATE NAME NAMESPACE ATTEMPT +4dccb216c4adb 2 minutes ago Ready nginx-65899c769f-wv2gp default 0 +``` + +### List images + +List all images: + +```bash +crictl images +``` +```none +IMAGE TAG IMAGE ID SIZE +busybox latest 8c811b4aec35f 1.15MB +k8s-gcrio.azureedge.net/hyperkube-amd64 v1.10.3 e179bbfe5d238 665MB +k8s-gcrio.azureedge.net/pause-amd64 3.1 da86e6ba6ca19 742kB +nginx latest cd5239a0906a6 109MB +``` + +List images by repository: + +```bash +crictl images nginx +``` +```none +IMAGE TAG IMAGE ID SIZE +nginx latest cd5239a0906a6 109MB +``` + +Only list image IDs: + +```bash +crictl images -q +``` +```none +sha256:8c811b4aec35f259572d0f79207bc0678df4c736eeec50bc9fec37ed936a472a +sha256:e179bbfe5d238de6069f3b03fccbecc3fb4f2019af741bfff1233c4d7b2970c5 +sha256:da86e6ba6ca197bf6bc5e9d900febd906b133eaa4750e6bed647b0fbe50ed43e +sha256:cd5239a0906a6ccf0562354852fae04bc5b52d72a2aff9a871ddb6bd57553569 +``` + +### List containers + +List all containers: + +```bash +crictl ps -a +``` +```none +CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT +1f73f2d81bf98 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 7 minutes ago Running sh 1 +9c5951df22c78 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 8 minutes ago Exited sh 0 +87d3992f84f74 nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f 8 minutes ago Running nginx 0 +1941fb4da154f k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a 18 hours ago Running kube-proxy 0 +``` + +List running containers: + +```bash +crictl ps +``` +```none +CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT +1f73f2d81bf98 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 6 minutes ago Running sh 1 +87d3992f84f74 nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f 7 minutes ago Running nginx 0 +1941fb4da154f k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a 17 hours ago Running kube-proxy 0 +``` + +### Execute a command in a running container + +```bash +crictl exec -i -t 1f73f2d81bf98 ls +``` +```none +bin dev etc home proc root sys tmp usr var +``` + +### Get a coontainer's logs + +Get all container logs: + +```bash +crictl logs 87d3992f84f74 +``` +```none +10.240.0.96 - - [06/Jun/2018:02:45:49 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +10.240.0.96 - - [06/Jun/2018:02:45:50 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +``` + +Get only the latest `N` lines of logs: + +```bash +crictl logs --tail=1 87d3992f84f74 +``` +```none +10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +``` + +### Run a pod sandbox + +Using `crictl` to run a pod sandbox is useful for debugging container runtimes. +On a running Kubernetes cluster, the sandbox will eventually be stopped and +deleted by the Kubelet. + +1. Create a JSON file like the following: + + ```json + { + "metadata": { + "name": "nginx-sandbox", + "namespace": "default", + "attempt": 1, + "uid": "hdishd83djaidwnduwk28bcsb" + }, + "logDirectory": "/tmp", + "linux": { + } + } + ``` + +2. Use the `crictl runp` command to apply the JSON and run the sandbox. + + ```bash + crictl runp pod-config.json + ``` + + The ID of the sandbox is returned. + +### Create a container + +Using `crictl` to create a container is useful for debugging container runtimes. +On a running Kubernetes cluster, the sandbox will eventually be stopped and +deleted by the Kubelet. + +1. Pull a busybox image + + ```bash + crictl pull busybox + Image is up to date for busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 + ``` + +2. Create configs for the pod and the container: + + **Pod config**: + ```yaml + { + "metadata": { + "name": "nginx-sandbox", + "namespace": "default", + "attempt": 1, + "uid": "hdishd83djaidwnduwk28bcsb" + }, + "log_directory": "/tmp", + "linux": { + } + } + ``` + + **Container config**: + ```yaml + { + "metadata": { + "name": "busybox" + }, + "image":{ + "image": "busybox" + }, + "command": [ + "top" + ], + "log_path":"busybox/0.log", + "linux": { + } + } + ``` + +3. Create the container, passing the ID of the previously-created pod, the + container config file, and the pod config file. The ID of the container is + returned. + + ```bash + crictl create f84dd361f8dc51518ed291fbadd6db537b0496536c1d2d6c05ff943ce8c9a54f container-config.json pod-config.json + ``` + +4. List all containers and verify that the newly-created container has its + state set to `Created`. + + ```bash + crictl ps -a + ``` + ```none + CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT + 3e025dd50a72d busybox 32 seconds ago Created busybox 0 + ``` + +### Start a container + +To start a container, pass its ID to `crictl start`: + +```bash +crictl start 3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60 +``` +```none +3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60 + +$ crictl ps +CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT +3e025dd50a72d busybox About a minute ago Running busybox 0 +``` + +{{% /capture %}} + + +{{% capture discussion %}} + +See [kubernetes-incubator/cri-tools](https://github.com/kubernetes-incubator/cri-tools) +for more information. + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md b/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md index 07c8a135e5987..8c02c0d5b1a1e 100644 --- a/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md +++ b/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md @@ -359,5 +359,4 @@ Learn about additional debugging tools, including: * [Getting into containers via `exec`](/docs/tasks/debug-application-cluster/get-shell-running-container/) * [Connecting to containers via proxies](/docs/tasks/access-kubernetes-api/http-proxy-access-api/) * [Connecting to containers via port forwarding](/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) - - +* [Inspect Kubernetes node with crictl](/docs/tasks/debug-application-cluster/crictl/) diff --git a/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md b/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md index 6435ebaa9b6ce..3434d8cc4e837 100644 --- a/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md +++ b/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md @@ -4,15 +4,42 @@ reviewers: title: Tools for Monitoring Compute, Storage, and Network Resources --- -Understanding how an application behaves when deployed is crucial to scaling the application and providing a reliable service. In a Kubernetes cluster, application performance can be examined at many different levels: containers, [pods](/docs/user-guide/pods), [services](/docs/user-guide/services), and whole clusters. As part of Kubernetes we want to provide users with detailed resource usage information about their running applications at all these levels. This will give users deep insights into how their applications are performing and where possible application bottlenecks may be found. In comes [Heapster](https://github.com/kubernetes/heapster), a project meant to provide a base monitoring platform on Kubernetes. +To scale and application and provide a reliable service, you need to +understand how an application behaves when it is deployed. You can examine +application performance in a Kubernetes cluster by examining the containers, +[pods](/docs/user-guide/pods), [services](/docs/user-guide/services), and +the characteristics of the overall cluster. Kubernetes provides detailed +information about an application's resource usage at each of these levels. +This information allows you to evaluate your application's performance and +where bottlenecks can be removed to improve overall performance. ## Overview -Heapster is a cluster-wide aggregator of monitoring and event data. It currently supports Kubernetes natively and works on all Kubernetes setups. Heapster runs as a pod in the cluster, similar to how any Kubernetes application would run. The Heapster pod discovers all nodes in the cluster and queries usage information from the nodes' [Kubelet](/docs/admin/kubelet/)s, the on-machine Kubernetes agent. The Kubelet itself fetches the data from [cAdvisor](https://github.com/google/cadvisor). Heapster groups the information by pod along with the relevant labels. This data is then pushed to a configurable backend for storage and visualization. Currently supported backends include [InfluxDB](http://influxdb.com/) (with [Grafana](http://grafana.org/) for visualization), [Google Cloud Monitoring](https://cloud.google.com/monitoring/) and many others described in more details [here](https://git.k8s.io/heapster/docs/sink-configuration.md). The overall architecture of the service can be seen below: +In Kubernetes, application monitoring does not depend on a single monitoring +solution. On new clusters, you can use two separate pipelines to collect +monitoring statistics by default: + +- The **resource metrics pipeline** provides a limited set of metrics related + to cluster components such as the HorizontalPodAutoscaler controller, as well + as the `kubectl top` utility. These metrics are collected by + [metrics-server](https://github.com/kubernetes-incubator/metrics-server) + and are exposed via the `metrics.k8s.io` API. `metrics-server` discovers + all nodes on the cluster and queries each node's [Kubelet](/docs/admin/kubelet) + for CPU and memory usage. The Kubelet fetches the data from + [cAdvisor](https://github.com/google/cadvisor). `metrics-server` is a + lightweight short-term in-memory store. + +- A **full monitoring pipeline**, such as Prometheus, gives you access to richer + metrics. In addition, Kubernetes can respond to these metrics by automatically + scaling or adapting the cluster based on its current state, using mechanisms + such as the Horizontal Pod Autoscaler. The monitoring pipeline fetches + metrics from the Kubelet, and then exposes them to Kubernetes via an adapter + by implementing either the `custom.metrics.k8s.io` or + `external.metrics.k8s.io` API. See + [Full metrics pipeline](#full-metrics-pipelines) for more information about + some popular pipelines that implement these APIs and enable these + capabilities. -![overall monitoring architecture](/images/docs/monitoring-architecture.png) - -Let's look at some of the other components in more detail. ### cAdvisor @@ -26,38 +53,35 @@ On most Kubernetes clusters, cAdvisor exposes a simple UI for on-machine contain The Kubelet acts as a bridge between the Kubernetes master and the nodes. It manages the pods and containers running on a machine. Kubelet translates each pod into its constituent containers and fetches individual container usage statistics from cAdvisor. It then exposes the aggregated pod resource usage statistics via a REST API. -## Storage Backends - -### InfluxDB and Grafana - -A Grafana setup with InfluxDB is a very popular combination for monitoring in the open source world. InfluxDB exposes an easy to use API to write and fetch time series data. Heapster is setup to use this storage backend by default on most Kubernetes clusters. A detailed setup guide can be found [here](https://github.com/GoogleCloudPlatform/heapster/blob/master/docs/influxdb.md). InfluxDB and Grafana run in Pods. The pod exposes itself as a Kubernetes service which is how Heapster discovers it. - -The Grafana container serves Grafana's UI which provides an easy to configure dashboard interface. The default dashboard for Kubernetes contains an example dashboard that monitors resource usage of the cluster and the pods inside of it. This dashboard can easily be customized and expanded. Take a look at the storage schema for InfluxDB [here](https://github.com/GoogleCloudPlatform/heapster/blob/master/docs/storage-schema.md#metrics). +## Full Metrics Pipelines -Here is a video showing how to monitor a Kubernetes cluster using heapster, InfluxDB and Grafana: +Many full metrics solutions exist for Kubernetes. Prometheus and Google Cloud +Monitoring are two of the most popular. -[![How to monitor a Kubernetes cluster using heapster, InfluxDB and Grafana](http://img.youtube.com/vi/SZgqjMrxo3g/0.jpg)](http://www.youtube.com/watch?v=SZgqjMrxo3g) +### Prometheus -Here is a snapshot of the default Kubernetes Grafana dashboard that shows the CPU and Memory usage of the entire cluster, individual pods and containers: - -![snapshot of the default Kubernetes Grafana dashboard](/images/docs/influx.png) +[Prometheus](https://prometheus.io) natively monitors Prometheus. +The [Prometheus Operator](https://coreos.com/operators/prometheus/docs/latest/) +simplifies Prometheus setup on Kubernetes, and allows you to serve the +custom metrics API using the +[Prometheus adapter](https://github.com/directxman12/k8s-prometheus-adapter). +Prometheus provides a robust query language and a built-in dashboard for +querying and visualizing your data. Prometheus is also a supported +data source for [Grafana](https://prometheus.io/docs/visualization/grafana/). ### Google Cloud Monitoring -Google Cloud Monitoring is a hosted monitoring service that allows you to visualize and alert on important metrics in your application. Heapster can be setup to automatically push all collected metrics to Google Cloud Monitoring. These metrics are then available in the [Cloud Monitoring Console](https://app.google.stackdriver.com/). This storage backend is the easiest to setup and maintain. The monitoring console allows you to easily create and customize dashboards using the exported data. +Google Cloud Monitoring is a hosted monitoring service you can use to +visualize and alert on important metrics in your application. can collect +metrics from Kubernetes, and you can access them +using the [Cloud Monitoring Console](https://app.google.stackdriver.com/). +You can create and customize dashboards to visualize the data gathered +from your Kubernetes cluster. -Here is a video showing how to setup and run a Google Cloud Monitoring backed Heapster: +This video shows how to configure and run a Google Cloud Monitoring backed Heapster: [![how to setup and run a Google Cloud Monitoring backed Heapster](http://img.youtube.com/vi/xSMNR2fcoLs/0.jpg)](http://www.youtube.com/watch?v=xSMNR2fcoLs) -Here is a snapshot of the Google Cloud Monitoring dashboard showing cluster-wide resource usage. - -![Google Cloud Monitoring dashboard](/images/docs/gcm.png) - -## Try it out! -Now that you've learned a bit about Heapster, feel free to try it out on your own clusters! The [Heapster repository](https://github.com/kubernetes/heapster) is available on GitHub. It contains detailed instructions to setup Heapster and its storage backends. Heapster runs by default on most Kubernetes clusters, so you may already have it! Feedback is always welcome. Please let us know if you run into any issues via the troubleshooting [channels](/docs/troubleshooting/). +{{< figure src="/images/docs/gcm.png" alt="Google Cloud Monitoring dashboard example" title="Google Cloud Monitoring dashboard example" caption="This dashboard shows cluster-wide resource usage." >}} -*** -*Authors: Vishnu Kannan and Victor Marmol, Google Software Engineers.* -*This article was originally posted in [Kubernetes Blog](https://kubernetes.io/blog/2015/05/resource-usage-monitoring-kubernetes).* diff --git a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md index 5f548e435269b..1059de12f511c 100644 --- a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md +++ b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md @@ -143,68 +143,3 @@ spec: This will ensure that the pod will be scheduled to a node that has the GPU type you specified. - -## v1.6 and v1.7 -To enable GPU support in 1.6 and 1.7, a special **alpha** feature gate -`Accelerators` has to be set to true across the system: -`--feature-gates="Accelerators=true"`. It also requires using the Docker -Engine as the container runtime. - -Further, the Kubernetes nodes have to be pre-installed with NVIDIA drivers. -Kubelet will not detect NVIDIA GPUs otherwise. - -When you start Kubernetes components after all the above conditions are true, -Kubernetes will expose `alpha.kubernetes.io/nvidia-gpu` as a schedulable -resource. - -You can consume these GPUs from your containers by requesting -`alpha.kubernetes.io/nvidia-gpu` just like you request `cpu` or `memory`. -However, there are some limitations in how you specify the resource requirements -when using GPUs: -- GPUs are only supposed to be specified in the `limits` section, which means: - * You can specify GPU `limits` without specifying `requests` because - Kubernetes will use the limit as the request value by default. - * You can specify GPU in both `limits` and `requests` but these two values - must be equal. - * You cannot specify GPU `requests` without specifying `limits`. -- Containers (and pods) do not share GPUs. There's no overcommitting of GPUs. -- Each container can request one or more GPUs. It is not possible to request a - fraction of a GPU. - -When using `alpha.kubernetes.io/nvidia-gpu` as the resource, you also have to -mount host directories containing NVIDIA libraries (libcuda.so, libnvidia.so -etc.) to the container. - -Here's an example: - -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: cuda-vector-add -spec: - restartPolicy: OnFailure - containers: - - name: cuda-vector-add - # https://github.com/kubernetes/kubernetes/blob/v1.7.11/test/images/nvidia-cuda/Dockerfile - image: "k8s.gcr.io/cuda-vector-add:v0.1" - resources: - limits: - alpha.kubernetes.io/nvidia-gpu: 1 # requesting 1 GPU - volumeMounts: - - name: "nvidia-libraries" - mountPath: "/usr/local/nvidia/lib64" - volumes: - - name: "nvidia-libraries" - hostPath: - path: "/usr/lib/nvidia-375" -``` - -The `Accelerators` feature gate and `alpha.kubernetes.io/nvidia-gpu` resource -works on 1.8 and 1.9 as well. It will be deprecated in 1.10 and removed in -1.11. - -## Future -- Support for hardware accelerators in Kubernetes is still in alpha. -- Better APIs will be introduced to provision and consume accelerators in a scalable manner. -- Kubernetes will automatically ensure that applications consuming GPUs get the best possible performance. diff --git a/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md b/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md index bc715cd62741e..1075207a55f9f 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md @@ -19,10 +19,10 @@ This document walks you through an example of enabling Horizontal Pod Autoscaler ## Prerequisites This example requires a running Kubernetes cluster and kubectl, version 1.2 or later. -[Heapster](https://github.com/kubernetes/heapster) monitoring needs to be deployed in the cluster -as Horizontal Pod Autoscaler uses it to collect metrics -(if you followed [getting started on GCE guide](/docs/getting-started-guides/gce), -heapster monitoring will be turned-on by default). +[metrics-server](https://github.com/kubernetes/heapster) monitoring needs to be deployed in the cluster +to provide metrics via the resource metrics API, as Horizontal Pod Autoscaler uses this API to collect metrics +(if you followed [getting started on GCE guide](/docs/getting-started-guides/gce.md), +metrics-server monitoring will be turned-on by default). To specify multiple resource metrics for a Horizontal Pod Autoscaler, you must have a Kubernetes cluster and kubectl at version 1.6 or later. Furthermore, in order to make use of custom metrics, your cluster @@ -196,7 +196,7 @@ Notice that the `targetCPUUtilizationPercentage` field has been replaced with an The CPU utilization metric is a *resource metric*, since it is represented as a percentage of a resource specified on pod containers. Notice that you can specify other resource metrics besides CPU. By default, the only other supported resource metric is memory. These resources do not change names from cluster -to cluster, and should always be available, as long as Heapster is deployed. +to cluster, and should always be available, as long as the `metrics.k8s.io` API is available. You can also specify resource metrics in terms of direct values, instead of as percentages of the requested value. To do so, use the `targetAverageValue` field instead of the `targetAverageUtilization` diff --git a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md index 46f2615624f1a..1cd61547a3900 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md @@ -57,19 +57,16 @@ or the custom metrics API (for all other metrics). * For object metrics, a single metric is fetched (which describes the object in question), and compared to the target value, to produce a ratio as above. -The HorizontalPodAutoscaler controller can fetch metrics in two different ways: direct Heapster -access, and REST client access. +The HorizontalPodAutoscaler normally fetches metrics a series of aggregated APIs (`metrics.k8s.io`,\ +`custom.metrics.k8s.io`, and `external.metrics.k8s.io`). It can also fetch metrics directly +from Heapster. Fetching metrics from Heapster is deprecated as of Kubernetes 1.11. -When using direct Heapster access, the HorizontalPodAutoscaler queries Heapster directly -through the API server's service proxy subresource. Heapster needs to be deployed on the -cluster and running in the kube-system namespace. - -See [Support for custom metrics](#support-for-custom-metrics) for more details on REST client access. - -The autoscaler accesses corresponding replication controller, deployment or replica set by scale sub-resource. -Scale is an interface that allows you to dynamically set the number of replicas and examine each of their current states. -More details on scale sub-resource can be found [here](https://git.k8s.io/community/contributors/design-proposals/autoscaling/horizontal-pod-autoscaler.md#scale-subresource). +See [Support for metrics APIs](#support-for-metrics-apis) for more details. +The autoscaler accesses corresponding scalable controllers (such as replication controllers, deployments, and replica sets) +by using the scale sub-resource. Scale is an interface that allows you to dynamically set the number of replicas and examine +each of their current states. More details on scale sub-resource can be found +[here](https://git.k8s.io/community/contributors/design-proposals/autoscaling/horizontal-pod-autoscaler.md#scale-subresource). ## API Object @@ -155,30 +152,27 @@ Kubernetes 1.6 adds support for making use of custom metrics in the Horizontal P You can add custom metrics for the Horizontal Pod Autoscaler to use in the `autoscaling/v2beta1` API. Kubernetes then queries the new custom metrics API to fetch the values of the appropriate custom metrics. -### Requirements - -To use custom metrics with your Horizontal Pod Autoscaler, you must set the necessary configurations when deploying your cluster: - -* [Enable the API aggregation layer](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) if you have not already done so. - -* Register your resource metrics API, your -custom metrics API and, optionally, external metrics API with the API aggregation layer. All of these API servers must be running *on* your cluster. +See [Support for metrics APIs](#support-for-metrics-APIs) for the requirements. - * *Resource Metrics API*: You can use Heapster's implementation of the resource metrics API, by running Heapster with its `--api-server` flag set to true. +## Support for metrics APIs - * *Custom Metrics API*: This must be provided by a separate component. To get started with boilerplate code, see the [kubernetes-incubator/custom-metrics-apiserver](https://github.com/kubernetes-incubator/custom-metrics-apiserver) and the [k8s.io/metrics](https://github.com/kubernetes/metrics) repositories. +By default, the HorizontalPodAutoscaler controller retrieves metrics from a series of APIs. In order for it to access these +APIs, cluster administrators must ensure that: - * *External Metrics API*: Starting from Kubernetes 1.10 you can use this API if you need to autoscale on metrics not related to any Kubernetes object. Similarly to *Custom Metrics API* this must be provided by a separate component. +* The [API aggregation layer](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) is enabled. -* Set the appropriate flags for kube-controller-manager: +* The corresponding APIs are registered: - * `--horizontal-pod-autoscaler-use-rest-clients` should be true. + * For resource metrics, this is the `metrics.k8s.io` API, generally provided by [metrics-server](https://github.com/kubernetes-incubator/metrics-server). + It can be launched as a cluster addon. - * `--kubeconfig ` OR `--master ` + * For custom metrics, this is the `custom.metrics.k8s.io` API. It's provided by "adapter" API servers provided by metrics solution vendors. + Check with your metrics pipeline, or the [list of known solutions](https://github.com/kubernetes/metrics/blob/master/IMPLEMENTATIONS.md#custom-metrics-api). + If you would like to write your own, check out the [boilerplate](https://github.com/kubernetes-incubator/custom-metrics-apiserver) to get started. - Note that either the `--master` or `--kubeconfig` flag can be used; `--master` will override `--kubeconfig` if both are specified. These flags specify the location of the API aggregation layer, allowing the controller manager to communicate to the API server. + * For external metrics, this is the `external.metrics.k8s.io` API. It may be provided by the custom metrics adapters provided above. - In Kubernetes 1.7, the standard aggregation layer that Kubernetes provides runs in-process with the kube-apiserver, so the target IP address can be found with `kubectl get pods --selector k8s-app=kube-apiserver --namespace kube-system -o jsonpath='{.items[0].status.podIP}'`. +* The `--horizontal-pod-autoscaler-use-rest-clients` is `true` or unset. Setting this to false switches to Heapster-based autoscaling, which is deprecated. ## Further reading diff --git a/content/en/docs/user-journeys/users/cluster-operator/intermediate.md b/content/en/docs/user-journeys/users/cluster-operator/intermediate.md index 68761eb7399e9..124e13dfbfd19 100644 --- a/content/en/docs/user-journeys/users/cluster-operator/intermediate.md +++ b/content/en/docs/user-journeys/users/cluster-operator/intermediate.md @@ -89,7 +89,7 @@ Kubernetes also supports a [core metrics pipeline](/docs/tasks/debug-application A common configuration on [Minikube](https://github.com/kubernetes/minikube) and some Kubernetes clusters uses [Heapster](https://github.com/kubernetes/heapster) [along with InfluxDB and Grafana](https://github.com/kubernetes/heapster/blob/master/docs/influxdb.md). There is a [walkthrough of how to install this configuration in your cluster](https://blog.kublr.com/how-to-utilize-the-heapster-influxdb-grafana-stack-in-kubernetes-for-monitoring-pods-4a553f4d36c9). -As of Kubernetes 1.9, the [sig-instrumentation](https://github.com/kubernetes/community/tree/master/sig-instrumentation) team is shifting away from an all-inclusive monitoring pattern with heapster, described in [Prometheus vs. Heapster vs. Kubernetes Metrics APIs](https://brancz.com/2018/01/05/prometheus-vs-heapster-vs-kubernetes-metrics-apis/). +As of Kubernetes 1.11, Heapster is deprecated, as per [sig-instrumentation](https://github.com/kubernetes/community/tree/master/sig-instrumentation). See [Prometheus vs. Heapster vs. Kubernetes Metrics APIs](https://brancz.com/2018/01/05/prometheus-vs-heapster-vs-kubernetes-metrics-apis/) for more information alternatives. Hosted data analytics services such as [Datadog](https://docs.datadoghq.com/integrations/kubernetes/) also offer Kubernetes integration. diff --git a/static/_redirects b/static/_redirects index 304d17d12e27f..ebb6906d4f34d 100644 --- a/static/_redirects +++ b/static/_redirects @@ -223,6 +223,8 @@ /docs/tasks/access-application-cluster/access-cluster.md /docs/tasks/access-application-cluster/access-cluster/ 301 /docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/ /docs/tasks/access-application-cluster/configure-access-multiple-clusters/ 301 /docs/tasks/access-kubernetes-api/access-kubernetes-api/http-proxy-access-api/ /docs/tasks/access-kubernetes-api/http-proxy-access-api/ 301 +/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/ /docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ 301 +/docs/tasks/access-kubernetes-api/migrate-third-party-resource/ /docs/tasks/access-kubernetes-api/custom-resources/migrate-third-party-resource/ 301 /docs/tasks/administer-cluster/apply-resource-quota-limit/ /docs/tasks/administer-cluster/quota-api-object/ 301 /docs/tasks/administer-cluster/assign-pods-nodes/ /docs/tasks/configure-pod-container/assign-pods-nodes/ 301 diff --git a/static/docs/reference/generated/kubectl/kubectl-commands.html b/static/docs/reference/generated/kubectl/kubectl-commands.html index 97b6efc8e80cc..c060bb0cef3b6 100644 --- a/static/docs/reference/generated/kubectl/kubectl-commands.html +++ b/static/docs/reference/generated/kubectl/kubectl-commands.html @@ -11,7 +11,7 @@ - +
  • example

GETTING STARTED

@@ -25,71 +25,26 @@ WORKING WITH APPS section to inspect them.

-

run

-
-

Start a single instance of nginx.

-
-
kubectl run nginx --image=nginx
-
-
-

Start a single instance of hazelcast and let the container expose port 5701 .

-
-
kubectl run hazelcast --image=hazelcast --port=5701
-
-
-

Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

-
-
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
-
-
-

Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

-
-
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
-
-
-

Start a replicated instance of nginx.

-
-
kubectl run nginx --image=nginx --replicas=5
-
-
-

Dry run. Print the corresponding API objects without creating them.

-
-
kubectl run nginx --image=nginx --dry-run
-
-
-

Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

-
-
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
-
-
-

Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

-
-
kubectl run -i -t busybox --image=busybox --restart=Never
-
-
-

Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

-
-
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
-
+

create

-

Start the nginx container using a different command and custom arguments.

+

Create a pod using the data in pod.json.

-
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
+
kubectl create -f ./pod.json
 

 

-
 Start the perl container to compute π to 2000 places and print it out.

+
 Create a pod based on the JSON passed into stdin.

 

-
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
cat pod.json | kubectl create -f -
 

 

-
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+
 Edit the data in docker-registry.yaml in JSON then create the resource using the edited data.

 

-
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
kubectl create -f docker-registry.yaml --edit -o json
 

-
Create and run a particular image, possibly replicated. 

-
Creates a deployment or job to manage the created container(s).

+
Create a resource from a file or from stdin. 

+
JSON and YAML formats are accepted.

 
Usage

-
$ run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...]

+
$ create -f FILENAME

 
Flags

 
@@ -108,154 +63,166 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
-
+
-
+
+
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
attachfalseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. 
commandfalseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
env[]Environment variables to set in the container 
exposeedit
 
 falseIf true, a public, external service is created for the container(s) which are run 
generatorThe name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. Edit the API resource before creating 
 

 
hostport-1The host port mapping for the container port. To demonstrate a single-machine container. filenamef[]Filename, directory, or URL to files to use to create the resource 
 

 
imageoutputo
 The image for the container to run. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
image-pull-policyraw
 
 The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server Raw URI to POST to the server.  Uses the transport specified by the kubeconfig file. 
 

 
include-extended-apisrecord
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
labelslComma separated labels to apply to the pod(s). Will override previous values. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
leave-stdin-opensave-config
 
 falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
limitsselectorl
 The resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
no-headerstemplate
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputo
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
output-versionvalidate
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). trueIf true, use a schema to validate the input before sending it 
 

 
overrideswindows-line-endings
 An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. falseOnly relevant if --edit=true. Defaults to the line ending native to your platform. 
 

+

+
clusterrole

+

+
 Create a ClusterRole named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

+

+
kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods
+

+

+
 Create a ClusterRole named "pod-reader" with ResourceName specified

+

+
kubectl create clusterrole pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod
+

+

+
 Create a ClusterRole named "foo" with API Group specified

+

+
kubectl create clusterrole foo --verb=get,list,watch --resource=rs.extensions
+

+

+
 Create a ClusterRole named "foo" with SubResource specified

+

+
kubectl create clusterrole foo --verb=get,list,watch --resource=pods,pods/status
+

+

+
 Create a ClusterRole name "foo" with NonResourceURL specified

+

+
kubectl create clusterrole "foo" --verb=get --non-resource-url=/logs/*
+

+

+
 Create a ClusterRole name "monitoring" with AggregationRule specified

+

+
kubectl create clusterrole monitoring --aggregation-rule="rbac.example.com/aggregate-to-monitoring=true"
+

+
Create a ClusterRole.

+
Usage

+
$ clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
+
+
@@ -264,52 +231,93 @@ 
Flags

-
+
-
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
-
-
-
+
+

 
pod-running-timeout1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running NameShorthandDefaultUsage
 

 
portaggregation-rule
 
 The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. An aggregation label selector for combining ClusterRoles. 
 

 
quietallow-missing-template-keys
 falseIf true, suppress prompt messages. trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
recorddry-run
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, only print the object that would be sent, without sending it. 
 

 
replicasr1Number of replicas to create for this container. Default is 1. non-resource-url[]A partial url that user should have access to. 
 

 
requestsoutputo
 The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
restartresource
 AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. []Resource that the rule applies to 
 

 
rmresource-name
 falseIf true, delete resources created in this command for attached containers. []Resource in the white list that the rule applies to, repeat this flag for multiple items 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
scheduletemplate
 
 A schedule in the Cron format the job should be run with. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
service-generatorvalidate
 service/v2The name of the generator to use for creating a service.  Only used if --expose is true trueIf true, use a schema to validate the input before sending it 
 

 
service-overridesverb
 An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. []Verb that applies to the resources contained in the rule 
 
serviceaccountService account to set in the pod spec 

+

+
clusterrolebinding

+

+
 Create a ClusterRoleBinding for user1, user2, and group1 using the cluster-admin ClusterRole

+

+
kubectl create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
+

+
Create a ClusterRoleBinding for a particular ClusterRole.

+
Usage

+
$ clusterrolebinding NAME --clusterrole=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
Flags

+
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
+
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
-
+
+
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
@@ -318,79 +326,46 @@ 
Flags

-
-
-
-
+
+
+
+
NameShorthandDefaultUsage
 

 
show-allaallow-missing-template-keys
 trueWhen printing, show all resources (default show all pods including terminated one.) If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
show-labelsclusterroleClusterRole this ClusterRoleBinding should reference 
dry-run
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, only print the object that would be sent, without sending it. 
 

 
sort-bygenerator
 clusterrolebinding.rbac.authorization.k8s.io/v1alpha1The name of the API generator to use. 
group
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Groups to bind to the role 
 

 
stdinioutputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
save-config
 falseKeep stdin open on the container(s) in the pod, even if nothing is attached. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
serviceaccount[]Service accounts to bind to the role, in the format : 
 

 

 template
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
ttytfalseAllocated a TTY for each container in the pod. validatetrueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
run-container

-

-
 Start a single instance of nginx.

-

-
kubectl run nginx --image=nginx
-

-

-
 Start a single instance of hazelcast and let the container expose port 5701 .

-

-
kubectl run hazelcast --image=hazelcast --port=5701
-

-

-
 Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

-

-
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
-

-

-
 Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

-

-
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
-

-

-
 Start a replicated instance of nginx.

-

-
kubectl run nginx --image=nginx --replicas=5
-

-

-
 Dry run. Print the corresponding API objects without creating them.

-

-
kubectl run nginx --image=nginx --dry-run
-

-

-
 Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

-

-
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
-

+
configmap

 

-
 Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

+
 Create a new configmap named my-config based on folder bar

 

-
kubectl run -i -t busybox --image=busybox --restart=Never
+
kubectl create configmap my-config --from-file=path/to/bar
 

 

-
 Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

+
 Create a new configmap named my-config with specified keys instead of file basenames on disk

 

-
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
+
kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
 

 

-
 Start the nginx container using a different command and custom arguments.

+
 Create a new configmap named my-config with key1=config1 and key2=config2

 

-
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
+
kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
 

 

-
 Start the perl container to compute π to 2000 places and print it out.

+
 Create a new configmap named my-config from the key=value pairs in the file

 

-
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
kubectl create configmap my-config --from-file=path/to/bar
 

 

-
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+
 Create a new configmap named my-config from an env file

 

-
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
kubectl create configmap my-config --from-env-file=path/to/bar.env
 

-
Create and run a particular image, possibly replicated. 

-
Creates a deployment or job to manage the created container(s).

+
Create a configmap based on a file, directory, or specified literal value. 

+
A single configmap may package one or more key/value pairs. 

+
When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content.  If the basename is an invalid key, you may specify an alternate key. 

+
When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap.  Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

 
Usage

-
$ run-container

+
$ configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

 
Flags

 
@@ -409,88 +384,111 @@ 
Flags

-
+
-
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
+
-
-
+
-
-
+
-
+
+
-
+
-
+
-
+
-
+
+
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
attachappend-hash
 
 falseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. Append a hash of the configmap to its name. 
 

 
commanddry-run
 
 falseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. If true, only print the object that would be sent, without sending it. 
 

 
dry-runfrom-env-file
 falseIf true, only print the object that would be sent, without sending it. Specify the path to a file to read lines of key=val pairs to create a configmap (i.e. a Docker .env file). 
 

 
envfrom-file
 
 []Environment variables to set in the container Key file can be specified using its file path, in which case file basename will be used as configmap key, or optionally with a key and file path, in which case the given key will be used.  Specifying a directory will iterate each named file in the directory whose basename is a valid configmap key. 
 

 
exposefrom-literal
 falseIf true, a public, external service is created for the container(s) which are run []Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) 
 

 

 generator
 The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. configmap/v1The name of the API generator to use. 
 

 
hostportoutputo
 -1The host port mapping for the container port. To demonstrate a single-machine container. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
imagesave-config
 The image for the container to run. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
image-pull-policytemplate
 
 The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
include-extended-apisvalidate
 
 trueIf true, include definitions of new APIs via calls to the API server. [default true] If true, use a schema to validate the input before sending it 

+

+
deployment

+

+
 Create a new deployment named my-dep that runs the busybox image.

+

+
kubectl create deployment my-dep --image=busybox
+

+
Create a deployment with the specified name.

+
Usage

+
$ deployment NAME --image=image [--dry-run]

+
Flags

+
+
+
+
+
+
+
+
+
-
-
+
-
+
+
-
+
-
+
-
+
-
+
-
+
-
-
+
+
@@ -499,64 +497,69 @@ 
Flags

-
-
+
-
+
+
-
-
+
-
-
-
-
-
-
+
-
-
+
-
-
-
-
-
-
-
+
+
+
+
NameShorthandDefaultUsage
 

 
labelslallow-missing-template-keys
 Comma separated labels to apply to the pod(s). Will override previous values. trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
leave-stdin-opendry-run
 
 falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. If true, only print the object that would be sent, without sending it. 
 

 
limitsgenerator
 
 The resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. The name of the API generator to use. 
 

 
no-headersimage
 falseWhen using the default or custom-column output format, don't print headers (default print headers). []Image name to run. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionsave-config
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
overridestemplate
 An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
pod-running-timeout
 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
portvalidate
 The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. 
quietfalseIf true, suppress prompt messages. trueIf true, use a schema to validate the input before sending it 
 

+

+
job

+

+
 Create a job from a CronJob named "a-cronjob"

+

+
kubectl create job test-job --from=cronjob/a-cronjob
+

+
Create a job with the specified name.

+
Usage

+
$ job NAME [--from=CRONJOB]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
@@ -565,52 +568,69 @@ 
Flags

-
+
-
+
-
+
-
-
+
+
+
+

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. NameShorthandDefaultUsage
 

 
replicasr1Number of replicas to create for this container. Default is 1. allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
requestsdry-run
 The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. falseIf true, only print the object that would be sent, without sending it. 
 

 
restartfrom
 AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. The name of the resource to create a Job from (only cronjob is supported). 
 

 
rmoutputo
 falseIf true, delete resources created in this command for attached containers. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
scheduletemplate
 
 A schedule in the Cron format the job should be run with. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
service-generatorvalidate
 service/v2The name of the generator to use for creating a service.  Only used if --expose is true trueIf true, use a schema to validate the input before sending it 
 

+

+
namespace

+

+
 Create a new namespace named my-namespace

+

+
kubectl create namespace my-namespace
+

+
Create a namespace with the specified name.

+
Usage

+
$ namespace NAME [--dry-run]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
-
-
-
-
-
-
+
-
+
-
+
-
+
+
+
+
+
+
+
-
+
-
-
+
+
-
+
@@ -619,56 +639,28 @@ 
Flags

-
-
-
-
+
+
+
+

 
service-overridesAn inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. NameShorthandDefaultUsage
 

 
serviceaccountallow-missing-template-keys
 Service account to set in the pod spec 
show-alla
 trueWhen printing, show all resources (default show all pods including terminated one.) If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
show-labelsdry-run
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, only print the object that would be sent, without sending it. 
 

 
sort-bygenerator
 namespace/v1The name of the API generator to use. 
outputo
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
stdinisave-config
 falseKeep stdin open on the container(s) in the pod, even if nothing is attached. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 

 template
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
ttytfalseAllocated a TTY for each container in the pod. validatetrueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
expose

-

-
 Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.

-

-
kubectl expose rc nginx --port=80 --target-port=8000
-

-

-
 Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000.

-

-
kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
-

-

-
 Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"

-

-
kubectl expose pod valid-pod --port=444 --name=frontend
-

-

-
 Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"

-

-
kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
-

-

-
 Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.

-

-
kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
-

+
poddisruptionbudget

 

-
 Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000.

+
 Create a pod disruption budget named my-pdb that will select all pods with the app=rails label # and require at least one of them being available at any point in time.

 

-
kubectl expose rs nginx --port=80 --target-port=8000
+
kubectl create poddisruptionbudget my-pdb --selector=app=rails --min-available=1
 

 

-
 Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000.

+
 Create a pod disruption budget named my-pdb that will select all pods with the app=nginx label # and require at least half of the pods selected to be available at any point in time.

 

-
kubectl expose deployment nginx --port=80 --target-port=8000
+
kubectl create pdb my-pdb --selector=app=nginx --min-available=50%
 

-
Expose a resource as a new Kubernetes service. 

-
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes. 

-
Possible resources include (case insensitive): 

-
pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)

+
Create a pod disruption budget with the specified name, selector, and desired minimum available pods

 
Usage

-
$ expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]

+
$ poddisruptionbudget NAME --selector=SELECTOR --min-available=N [--dry-run]

 
Flags

 
@@ -687,64 +679,28 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
-
+
-
-
-
-
-
-
+
@@ -753,42 +709,6 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -798,132 +718,37 @@ 
Flags

-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
cluster-ipClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service. 
container-portSynonym for --target-port 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
external-ipAdditional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. 
filenamef[]Filename, directory, or URL to files identifying the resource to expose a service 

 generator
 service/v2The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. 
labelslLabels to apply to the service created by this call. poddisruptionbudget/v1beta1/v2The name of the API generator to use. 
 

 
load-balancer-ipmax-unavailable
 
 IP to assign to the LoadBalancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). The maximum number or percentage of unavailable pods this budget requires. 
 

 
namemin-available
 The name for the newly created object. 
no-headers
 falseWhen using the default or custom-column output format, don't print headers (default print headers). The minimum number or percentage of available pods this budget requires. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
overridesAn inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
portThe port that the service should serve on. Copied from the resource being exposed, if unspecified 
protocolThe network protocol for the service to be created. Default is 'TCP'. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

 save-config
 
 false
 selector
 
 A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set.) A label selector to use for this budget. Only equality-based selector requirements are supported. 
 

 
session-affinitytemplate
 
 If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
target-portName or number for the port on the container that the service should direct traffic to. Optional. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
typevalidate
 Type for this service: ClusterIP, NodePort, LoadBalancer, or ExternalName. Default is 'ClusterIP'. trueIf true, use a schema to validate the input before sending it 
 

 
 

-
APP MANAGEMENT

-
This section contains commands for creating, updating, deleting, and
-viewing your workloads in a Kubernetes cluster.

 

-
annotate

-

-
 Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied

-

-
kubectl annotate pods foo description='my frontend'
-

-

-
 Update a pod identified by type and name in "pod.json"

-

-
kubectl annotate -f pod.json description='my frontend'
-

-

-
 Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value.

-

-
kubectl annotate --overwrite pods foo description='my frontend running nginx'
-

-

-
 Update all pods in the namespace

-

-
kubectl annotate pods --all description='my frontend running nginx'
-

+
priorityclass

 

-
 Update pod 'foo' only if the resource is unchanged from version 1.

+
 Create a priorityclass named high-priority

 

-
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
+
kubectl create priorityclass default-priority --value=1000 --description="high priority"
 

 

-
 Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the --overwrite flag.

+
 Create a priorityclass named default-priority that considered as the global default priority

 

-
kubectl annotate pods foo description-
+
kubectl create priorityclass default-priority --value=1000 --global-default=true --description="default priority"
 

-
Update the annotations on one or more resources 

-
All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data. 

-
Attempting to set an annotation that already exists will fail unless --overwrite is set. If --resource-version is specified and does not match the current resource version on the server the command will fail.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

+
Create a priorityclass with the specified name, value, globalDefault and description

 
Usage

-
$ annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

+
$ priorityclass NAME --value=VALUE --global-default=BOOL [--dry-run]

 
Flags

 
@@ -936,112 +761,134 @@ 
Flags

-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
+
-
+
+
-
-
+
-
+
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types. 

 allow-missing-template-keys
 
 true
 If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
descriptiondescription is an arbitrary string that usually provides guidelines on when this priority class should be used. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
filenamef[]Filename, directory, or URL to files identifying the resource to update the annotation 
include-extended-apisgenerator
 trueIf true, include definitions of new APIs via calls to the API server. [default true] priorityclass/v1alpha1The name of the API generator to use. 
 

 
include-uninitializedglobal-default
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. global-default specifies whether this PriorityClass should be considered as the default priority. 
 

 
localoutputo
 falseIf true, annotation will NOT contact api-server but run locally. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
no-headerssave-config
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
outputotemplate
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
output-versionvalidate
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). trueIf true, use a schema to validate the input before sending it 
 

 
overwritevalue
 falseIf true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. 0the value of this priority class. 

+

+
quota

+

+
 Create a new resourcequota named my-quota

+

+
kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
+

+

+
 Create a new resourcequota named best-effort

+

+
kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
+

+
Create a resourcequota with the specified name, hard limits and optional scopes

+
Usage

+
$ quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool]

+
Flags

+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
-
+
+
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
-
-
-
+
+
+
+
-
+
-
+
-
+
-
+
@@ -1049,24 +896,39 @@ 
Flags

+
+
+
+
+
+
NameShorthandDefaultUsage
 

 
recordallow-missing-template-keys
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
recursiveRdry-run
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, only print the object that would be sent, without sending it. 
 

 
resource-versiongenerator
 If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. resourcequotas/v1The name of the API generator to use. 
 

 
selectorlhard
 Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). A comma-delimited set of resource=quantity pairs that define a hard limit. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
show-labelssave-config
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
sort-byscopes
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. A comma-delimited set of quota scopes that must all match each object tracked by the quota. 
 

 

 template
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 
validatetrueIf true, use a schema to validate the input before sending it 

 
 

 

-
autoscale

+
role

 

-
 Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used:

+
 Create a Role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

 

-
kubectl autoscale deployment foo --min=2 --max=10
+
kubectl create role pod-reader --verb=get --verb=list --verb=watch --resource=pods
 

 

-
 Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%:

+
 Create a Role named "pod-reader" with ResourceName specified

 

-
kubectl autoscale rc foo --max=5 --cpu-percent=80
+
kubectl create role pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod
 

-
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. 

-
Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.

+

+
 Create a Role named "foo" with API Group specified

+

+
kubectl create role foo --verb=get,list,watch --resource=rs.extensions
+

+

+
 Create a Role named "foo" with SubResource specified

+

+
kubectl create role foo --verb=get,list,watch --resource=pods,pods/status
+

+
Create a role with single rule.

 
Usage

-
$ autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU]

+
$ role NAME --verb=verb --resource=resource.group/subresource [--resource-name=resourcename] [--dry-run]

 
Flags

 
@@ -1085,106 +947,129 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
+
+
-
-
+
-
+
+
+
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
cpu-percent-1The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
filenamef[]Filename, directory, or URL to files identifying the resource to autoscale. 
generatoroutputo
 horizontalpodautoscaler/v1The name of the API generator to use. Currently there is only 1 generator. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
include-extended-apisresource
 trueIf true, include definitions of new APIs via calls to the API server. [default true] []Resource that the rule applies to 
 

 
maxresource-name
 -1The upper limit for the number of pods that can be set by the autoscaler. Required. []Resource in the white list that the rule applies to, repeat this flag for multiple items 
 

 
minsave-config
 -1The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
nametemplate
 
 The name for the newly created object. If not specified, the name of the input resource will be used. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
no-headersvalidate
 falseWhen using the default or custom-column output format, don't print headers (default print headers). trueIf true, use a schema to validate the input before sending it 
 

 
outputoverb
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. []Verb that applies to the resources contained in the rule 

+

+
rolebinding

+

+
 Create a RoleBinding for user1, user2, and group1 using the admin ClusterRole

+

+
kubectl create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
+

+
Create a RoleBinding for a particular Role or ClusterRole.

+
Usage

+
$ rolebinding NAME --clusterrole=NAME|--role=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
Flags

+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -1192,30 +1077,36 @@ 
Flags

+
+
+
+
+
+
NameShorthandDefaultUsage
 

 
output-versionallow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
clusterrole
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). ClusterRole this RoleBinding should reference 
 

 
recorddry-run
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, only print the object that would be sent, without sending it. 
 

 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. generatorrolebinding.rbac.authorization.k8s.io/v1alpha1The name of the API generator to use. 
 

 
save-configgroup
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. []Groups to bind to the role 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
show-labelsrole
 falseWhen printing, show all labels as the last column (default hide labels column) Role this RoleBinding should reference 
 

 
sort-bysave-config
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
serviceaccount
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Service accounts to bind to the role, in the format : 
 

 

 template
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 
validatetrueIf true, use a schema to validate the input before sending it 

 
 

 

-
convert

-

-
 Convert 'pod.yaml' to latest version and print to stdout.

-

-
kubectl convert -f pod.yaml
-

-

-
 Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in JSON format.

-

-
kubectl convert -f pod.yaml --local -o json
-

+
secret

+
Create a secret using specified subcommand.

+
Usage

+
$ secret

+

+
secret docker-registry

 

-
 Convert all files under current directory to latest version and create them all.

+
 If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:

 

-
kubectl convert -f . | kubectl create -f -
+
kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
 

-
Convert config files between different API versions. Both YAML and JSON formats are accepted. 

-
The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version. 

-
The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.

+
Create a new secret for use with Docker registries.

+
  Dockercfg secrets are used to authenticate against Docker registries.

+
  When using the Docker command line to push images, you can authenticate to a given registry by running:
+      '$ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.

+
That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. The email address is optional. 

+
  When creating applications, you may have a Docker registry that requires authentication.  In order for the
+  nodes to pull images on your behalf, they have to have the credentials.  You can provide this information
+  by creating a dockercfg secret and attaching it to your service account.

 
Usage

-
$ convert -f FILENAME

+
$ docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run]

 
Flags

 
@@ -1234,64 +1125,64 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -1308,26 +1199,38 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
filenamef[]Filename, directory, or URL to files to need to get converted. 
include-extended-apisappend-hash
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseAppend a hash of the secret to its name. 
 

 
localdocker-email
 trueIf true, convert will NOT try to contact api-server but run locally. Email for Docker registry 
 

 
no-headersdocker-password
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Password for Docker registry authentication 
 

 
outputodocker-server
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. https://index.docker.io/v1/Server location for Docker registry 
 

 
output-versiondocker-username
 
 Output the formatted object with the given group version (for ex: 'extensions/v1beta1').) Username for Docker registry authentication 
 

 
recursiveRdry-run
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, only print the object that would be sent, without sending it. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) from-file[]Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used.  Specifying a directory will iterate each named file in the directory that is a valid secret key. 
 

 
show-labelsgenerator
 falseWhen printing, show all labels as the last column (default hide labels column) secret-for-docker-registry/v1The name of the API generator to use. 
 

 
sort-byoutputo
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
save-config
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 

 template
 
 

 

-
create

+
secret generic

 

-
 Create a pod using the data in pod.json.

+
 Create a new secret named my-secret with keys for each file in folder bar

 

-
kubectl create -f ./pod.json
+
kubectl create secret generic my-secret --from-file=path/to/bar
 

 

-
 Create a pod based on the JSON passed into stdin.

+
 Create a new secret named my-secret with specified keys instead of names on disk

 

-
cat pod.json | kubectl create -f -
+
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub
+

+

+
 Create a new secret named my-secret with key1=supersecret and key2=topsecret

+

+
kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
 

 

-
 Edit the data in docker-registry.yaml in JSON using the v1 API format then create the resource using the edited data.

+
 Create a new secret named my-secret using a combination of a file and a literal

 

-
kubectl create -f docker-registry.yaml --edit --output-version=v1 -o json
+
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-literal=passphrase=topsecret
 

-
Create a resource from a file or from stdin. 

-
JSON and YAML formats are accepted.

+

+
 Create a new secret named my-secret from an env file

+

+
kubectl create secret generic my-secret --from-env-file=path/to/bar.env
+

+
Create a secret based on a file, directory, or specified literal value. 

+
A single secret may package one or more key/value pairs. 

+
When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key. 

+
When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

 
Usage

-
$ create -f FILENAME

+
$ generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

 
Flags

 
@@ -1346,34 +1249,40 @@ 
Flags

+
+
+
+
+
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
+
+
@@ -1382,64 +1291,22 @@ 
Flags

-
-
+
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
@@ -1447,44 +1314,19 @@ 
Flags

-
-
-
-
-
-

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
append-hashfalseAppend a hash of the secret to its name. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
editfrom-env-file
 falseEdit the API resource before creating Specify the path to a file to read lines of key=val pairs to create a secret (i.e. a Docker .env file). 
 

 
filenameffrom-file
 []Filename, directory, or URL to files to use to create the resource Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used.  Specifying a directory will iterate each named file in the directory that is a valid secret key. 
 

 
include-extended-apisfrom-literal
 trueIf true, include definitions of new APIs via calls to the API server. [default true] []Specify a key and literal value to insert in secret (i.e. mykey=somevalue) 
 

 
no-headersgenerator
 falseWhen using the default or custom-column output format, don't print headers (default print headers). secret/v1The name of the API generator to use. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionsave-config
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
rawtemplate
 
 Raw URI to POST to the server.  Uses the transport specified by the kubeconfig file. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templatetype
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. The type of secret to create 
 

 

 validate
 true
 If true, use a schema to validate the input before sending it 
 
windows-line-endingsfalseOnly relevant if --edit=true. Defaults to the line ending native to your platform. 

 
 

 

-
clusterrole

-

-
 Create a ClusterRole named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

-

-
kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods
-

-

-
 Create a ClusterRole named "pod-reader" with ResourceName specified

-

-
kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods --resource-name=readablepod --resource-name=anotherpod
-

-

-
 Create a ClusterRole named "foo" with API Group specified

-

-
kubectl create clusterrole foo --verb=get,list,watch --resource=rs.extensions
-

-

-
 Create a ClusterRole named "foo" with SubResource specified

-

-
kubectl create clusterrole foo --verb=get,list,watch --resource=pods,pods/status
-

+
secret tls

 

-
 Create a ClusterRole name "foo" with NonResourceURL specified

+
 Create a new TLS secret named tls-secret with the given key pair:

 

-
kubectl create clusterrole "foo" --verb=get --non-resource-url=/logs/*
+
kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
 

-
Create a ClusterRole.

+
Create a TLS secret from the given public/private key pair. 

+
The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key.

 
Usage

-
$ clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run]

+
$ tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run]

 
Flags

 
@@ -1503,46 +1345,40 @@ 
Flags

-
+
-
+
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
@@ -1551,24 +1387,6 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1580,24 +1398,28 @@ 
Flags

-
-
-
-
-
-

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
dry-runappend-hash
 
 falseIf true, only print the object that would be sent, without sending it. Append a hash of the secret to its name. 
 

 
no-headerscert
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
non-resource-url
 []A partial url that user should have access to. Path to PEM encoded public key certificate. 
 

 
outputodry-run
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseIf true, only print the object that would be sent, without sending it. 
 

 
output-versiongenerator
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). secret-for-tls/v1The name of the API generator to use. 
 

 
resourcekey
 []Resource that the rule applies to Path to private key associated with given certificate. 
 

 
resource-nameoutputo
 []Resource in the white list that the rule applies to, repeat this flag for multiple items Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 

 template
 
 
 true
 If true, use a schema to validate the input before sending it 
 
verb[]Verb that applies to the resources contained in the rule 

 
 

 

-
clusterrolebinding

+
service

+
Create a service using specified subcommand.

+
Usage

+
$ service

+

+
service clusterip

 

-
 Create a ClusterRoleBinding for user1, user2, and group1 using the cluster-admin ClusterRole

+
 Create a new ClusterIP service named my-cs

 

-
kubectl create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
+
kubectl create service clusterip my-cs --tcp=5678:8080
 

-
Create a ClusterRoleBinding for a particular ClusterRole.

+

+
 Create a new ClusterIP service named my-cs (in headless mode)

+

+
kubectl create service clusterip my-cs --clusterip="None"
+

+
Create a ClusterIP service with the specified name.

 
Usage

-
$ clusterrolebinding NAME --clusterrole=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
$ clusterip NAME [--tcp=<port>:<targetPort>] [--dry-run]

 
Flags

 
@@ -1616,10 +1438,10 @@ 
Flags

-
+
-
+
@@ -1630,62 +1452,26 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -1702,38 +1488,16 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
clusterroleclusterip
 
 ClusterRole this ClusterRoleBinding should reference Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing). 
 

 

 dry-run
 

 generator
 clusterrolebinding.rbac.authorization.k8s.io/v1alpha1service-clusterip/v1
 The name of the API generator to use. 
 

 
group[]Groups to bind to the role 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
serviceaccounttcp
 
 []Service accounts to bind to the role, in the format : 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
configmap

-

-
 Create a new configmap named my-config based on folder bar

-

-
kubectl create configmap my-config --from-file=path/to/bar
-

-

-
 Create a new configmap named my-config with specified keys instead of file basenames on disk

-

-
kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
-

-

-
 Create a new configmap named my-config with key1=config1 and key2=config2

-

-
kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
-

-

-
 Create a new configmap named my-config from the key=value pairs in the file

-

-
kubectl create configmap my-config --from-file=path/to/bar
-

+
service externalname

 

-
 Create a new configmap named my-config from an env file

+
 Create a new ExternalName service named my-ns

 

-
kubectl create configmap my-config --from-env-file=path/to/bar.env
+
kubectl create service externalname my-ns --external-name bar.com
 

-
Create a configmap based on a file, directory, or specified literal value. 

-
A single configmap may package one or more key/value pairs. 

-
When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content.  If the basename is an invalid key, you may specify an alternate key. 

-
When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap.  Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

+
Create an ExternalName service with the specified name. 

+
ExternalName service references to an external DNS address instead of only pods, which will allow application authors to reference services that exist off platform, on other clusters, or locally.

 
Usage

-
$ configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

+
$ externalname NAME --external-name external.name [--dry-run]

 
Flags

 
@@ -1752,82 +1516,40 @@ 
Flags

-
-
-
-
-
-
-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
@@ -1844,15 +1566,15 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
append-hashfalseAppend a hash of the configmap to its name. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
from-env-fileexternal-name
 
 Specify the path to a file to read lines of key=val pairs to create a configmap (i.e. a Docker .env file). External name of service 
 

 
from-filegenerator
 []Key file can be specified using its file path, in which case file basename will be used as configmap key, or optionally with a key and file path, in which case the given key will be used.  Specifying a directory will iterate each named file in the directory whose basename is a valid configmap key. 
from-literal[]Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) 
generatorconfigmap/v1service-externalname/v1
 The name of the API generator to use. 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-bytcp
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
deployment

+
service loadbalancer

 

-
 Create a new deployment named my-dep that runs the busybox image.

+
 Create a new LoadBalancer service named my-lbs

 

-
kubectl create deployment my-dep --image=busybox
+
kubectl create service loadbalancer my-lbs --tcp=5678:8080
 

-
Create a deployment with the specified name.

+
Create a LoadBalancer service with the specified name.

 
Usage

-
$ deployment NAME --image=image [--dry-run]

+
$ loadbalancer NAME [--tcp=port:targetPort] [--dry-run]

 
Flags

 
@@ -1879,56 +1601,26 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
@@ -1945,15 +1637,15 @@ 
Flags

 
 

 generator
 deployment-basic/v1beta1service-loadbalancer/v1
 The name of the API generator to use. 
 

 
image[]Image name to run. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-bytcp
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
job

+
service nodeport

 

-
 Create a job from a CronJob named "a-cronjob"

+
 Create a new NodePort service named my-ns

 

-
kubectl create job --from=cronjob/a-cronjob
+
kubectl create service nodeport my-ns --tcp=5678:8080
 

-
Create a job with the specified name.

+
Create a NodePort service with the specified name.

 
Usage

-
$ job NAME [--from-cronjob=CRONJOB]

+
$ nodeport NAME [--tcp=port:targetPort] [--dry-run]

 
Flags

 
@@ -1972,16 +1664,22 @@ 
Flags

-
+
+
+
+
+
+
-
+
+
-
+
-
-
+
+
@@ -1990,34 +1688,16 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
@@ -2034,15 +1714,15 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
fromdry-run
 falseIf true, only print the object that would be sent, without sending it. 
generator
 The name of the resource to create a Job from (only cronjob is supported). service-nodeport/v1The name of the API generator to use. 
 

 
no-headersnode-port
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 0Port used to expose the service on each node in a cluster. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-bytcp
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
namespace

+
serviceaccount

 

-
 Create a new namespace named my-namespace

+
 Create a new service account named my-service-account

 

-
kubectl create namespace my-namespace
+
kubectl create serviceaccount my-service-account
 

-
Create a namespace with the specified name.

+
Create a service account with the specified name.

 
Usage

-
$ namespace NAME [--dry-run]

+
$ serviceaccount NAME [--dry-run]

 
Flags

 
@@ -2069,52 +1749,22 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -2129,20 +1779,59 @@ 
Flags

 
 

 generator
 namespace/v1serviceaccount/v1
 The name of the API generator to use. 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 

 template
 
 
 
 

 

-
poddisruptionbudget

+
get

 

-
 Create a pod disruption budget named my-pdb that will select all pods with the app=rails label # and require at least one of them being available at any point in time.

+
 List all pods in ps output format.

 

-
kubectl create poddisruptionbudget my-pdb --selector=app=rails --min-available=1
+
kubectl get pods
 

 

-
 Create a pod disruption budget named my-pdb that will select all pods with the app=nginx label # and require at least half of the pods selected to be available at any point in time.

+
 List all pods in ps output format with more information (such as node name).

 

-
kubectl create pdb my-pdb --selector=app=nginx --min-available=50%
+
kubectl get pods -o wide
 

-
Create a pod disruption budget with the specified name, selector, and desired minimum available pods

+

+
 List a single replication controller with specified NAME in ps output format.

+

+
kubectl get replicationcontroller web
+

+

+
 List deployments in JSON output format, in the "v1" version of the "apps" API group:

+

+
kubectl get deployments.v1.apps -o json
+

+

+
 List a single pod in JSON output format.

+

+
kubectl get -o json pod web-pod-13je7
+

+

+
 List a pod identified by type and name specified in "pod.yaml" in JSON output format.

+

+
kubectl get -f pod.yaml -o json
+

+

+
 Return only the phase value of the specified pod.

+

+
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
+

+

+
 List all replication controllers and services together in ps output format.

+

+
kubectl get rc,services
+

+

+
 List one or more resources by their type and names.

+

+
kubectl get rc/web service/frontend pods/web-pod-13je7
+

+
Display one or many resources 

+
Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in your current namespace unless you pass --all-namespaces. 

+
Uninitialized objects are not shown unless --include-uninitialized is passed. 

+
By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources.

+
Use "kubectl api-resources" for a complete list of supported resources.

 
Usage

-
$ poddisruptionbudget NAME --selector=SELECTOR --min-available=N [--dry-run]

+
$ get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE[.VERSION][.GROUP] [NAME | -l label] | TYPE[.VERSION][.GROUP]/NAME ...) [flags]

 
Flags

 
@@ -2155,37 +1844,61 @@ 
Flags

+
+
+
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2197,22 +1910,28 @@ 
Flags

-
+
-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -2221,6 +1940,12 @@ 
Flags

+
+
+
+
+
+
@@ -2239,28 +1964,91 @@ 
Flags

-
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
all-namespacesfalseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 

 allow-missing-template-keys
 
 true
 If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
dry-runchunk-size
 falseIf true, only print the object that would be sent, without sending it. 500Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future. 
 

 
generatorexport
 poddisruptionbudget/v1beta1/v2The name of the API generator to use. falseIf true, use 'export' for the resources.  Exported resources are stripped of cluster-specific information. 
 

 
max-unavailablefield-selector
 
 The maximum number or percentage of unavailable pods this budget requires. Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 
min-availableThe minimum number or percentage of available pods this budget requires. filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
no-headersignore-not-foundfalseIf the requested object does not exist the command will return exit code 0. 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
label-columnsL[]Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... 
no-headers
 
 false
 When using the default or custom-column output format, don't print headers (default print headers). 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionraw
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). Raw URI to request from the server.  Uses the transport specified by the kubeconfig file. 
 

 
save-configrecursiveR
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 

 selectorl
 Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
server-print
 A label selector to use for this budget. Only equality-based selector requirements are supported. trueIf true, have the server return the appropriate table output. Supports extension APIs and CRDs. 
 

 

 show-all
 When printing, show all resources (default show all pods including terminated one.) 
 

 
show-kindfalseIf present, list the resource type for the requested object(s). 

 show-labels
 
 false
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
validateuse-openapi-print-columns
 trueIf true, use a schema to validate the input before sending it falseIf true, use x-kubernetes-print-column metadata (if present) from the OpenAPI schema for displaying a resource. 
watchwfalseAfter listing/getting the requested object, watch for changes. Uninitialized objects are excluded if no object name is provided. 
watch-onlyfalseWatch for changes to the requested object(s), without listing/getting first. 
 

 
 

 

-
priorityclass

+
run

 

-
 Create a priorityclass named high-priority

+
 Start a single instance of nginx.

 

-
kubectl create priorityclass default-priority --value=1000 --description="high priority"
+
kubectl run nginx --image=nginx
 

 

-
 Create a priorityclass named default-priority that considered as the global default priority

+
 Start a single instance of hazelcast and let the container expose port 5701 .

 

-
kubectl create priorityclass default-priority --value=1000 --global-default=true --description="default priority"
+
kubectl run hazelcast --image=hazelcast --port=5701
 

-
Create a priorityclass with the specified name, value, globalDefault and description

+

+
 Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

+

+
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
+

+

+
 Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

+

+
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
+

+

+
 Start a replicated instance of nginx.

+

+
kubectl run nginx --image=nginx --replicas=5
+

+

+
 Dry run. Print the corresponding API objects without creating them.

+

+
kubectl run nginx --image=nginx --dry-run
+

+

+
 Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

+

+
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
+

+

+
 Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

+

+
kubectl run -i -t busybox --image=busybox --restart=Never
+

+

+
 Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

+

+
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
+

+

+
 Start the nginx container using a different command and custom arguments.

+

+
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
+

+

+
 Start the perl container to compute π to 2000 places and print it out.

+

+
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+

+
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+

+
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+
Create and run a particular image, possibly replicated. 

+
Creates a deployment or job to manage the created container(s).

 
Usage

-
$ priorityclass NAME --value=VALUE --global-default=BOOL [--dry-run]

+
$ run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...]

 
Flags

 
@@ -2273,16 +2061,22 @@ 
Flags

-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -2291,146 +2085,142 @@ 
Flags

-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
+
-
+
+
-
-
+
-
+
-
-
+
+
-
-

 
 
 
 
allow-missing-template-keysattach
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. 
 

 
descriptioncascade
 trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
command
 description is an arbitrary string that usually provides guidelines on when this priority class should be used. falseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
generatorenv
 priorityclass/v1alpha1The name of the API generator to use. []Environment variables to set in the container 
 

 
global-defaultexpose
 
 falseglobal-default specifies whether this PriorityClass should be considered as the default priority. If true, a public, external service is created for the container(s) which are run 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). filenamef[]to use to replace the resource. 
 

 
outputoforce
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
output-versiongenerator
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. 
 

 
save-configgrace-period
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
show-labelshostport
 falseWhen printing, show all labels as the last column (default hide labels column) -1The host port mapping for the container port. To demonstrate a single-machine container. 
 

 
sort-byimage
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. The image for the container to run. 
 

 
templateimage-pull-policy
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server 
 

 
validatelabelsl
 trueIf true, use a schema to validate the input before sending it Comma separated labels to apply to the pod(s). Will override previous values. 
 

 
valueleave-stdin-open
 0the value of this priority class. falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. 
 

-

-
quota

-

-
 Create a new resourcequota named my-quota

-

-
kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
-

-

-
 Create a new resourcequota named best-effort

-

-
kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
-

-
Create a resourcequota with the specified name, hard limits and optional scopes

-
Usage

-
$ quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool]

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
+
+
-
-
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
+
-
-
+
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
@@ -2439,68 +2229,98 @@ 
Flags

-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
-
+
-
-
+
+
+
+
+
+
+
-
+
+
-
+
+
+
+
+
+
+
-
-
+
+

 
NameShorthandDefaultUsagelimitsThe resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. 
 

 
allow-missing-template-keysoutputo
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
dry-runoverrides
 falseIf true, only print the object that would be sent, without sending it. An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
 

 
generatorpod-running-timeout
 resourcequotas/v1The name of the API generator to use. 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

 
hardport
 
 A comma-delimited set of resource=quantity pairs that define a hard limit. The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. 
 

 
no-headersquiet
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, suppress prompt messages. 
 

 
outputorecord
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
output-versionrecursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
replicasr1Number of replicas to create for this container. Default is 1. 
requestsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
restart
 AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. 
rm
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, delete resources created in this command for attached containers. 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
scopesschedule
 
 A comma-delimited set of quota scopes that must all match each object tracked by the quota. A schedule in the Cron format the job should be run with. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) service-generatorservice/v2The name of the generator to use for creating a service.  Only used if --expose is true 
 

 
show-labelsservice-overrides
 falseWhen printing, show all labels as the last column (default hide labels column) An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. 
 

 
sort-byserviceaccount
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Service account to set in the pod spec 
 

 
templatestdinifalseKeep stdin open on the container(s) in the pod, even if nothing is attached. 
timeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
validatettytfalseAllocated a TTY for each container in the pod. 
wait
 trueIf true, use a schema to validate the input before sending it falseIf true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

 

-
role

+
expose

 

-
 Create a Role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

+
 Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.

 

-
kubectl create role pod-reader --verb=get --verb=list --verb=watch --resource=pods
+
kubectl expose rc nginx --port=80 --target-port=8000
 

 

-
 Create a Role named "pod-reader" with ResourceName specified

+
 Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000.

 

-
kubectl create role pod-reader --verb=get,list,watch --resource=pods --resource-name=readablepod --resource-name=anotherpod
+
kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
 

 

-
 Create a Role named "foo" with API Group specified

+
 Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"

 

-
kubectl create role foo --verb=get,list,watch --resource=rs.extensions
+
kubectl expose pod valid-pod --port=444 --name=frontend
 

 

-
 Create a Role named "foo" with SubResource specified

+
 Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"

 

-
kubectl create role foo --verb=get,list,watch --resource=pods,pods/status
+
kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
 

-
Create a role with single rule.

+

+
 Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.

+

+
kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
+

+

+
 Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000.

+

+
kubectl expose rs nginx --port=80 --target-port=8000
+

+

+
 Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000.

+

+
kubectl expose deployment nginx --port=80 --target-port=8000
+

+
Expose a resource as a new Kubernetes service. 

+
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes. 

+
Possible resources include (case insensitive): 

+
pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)

 
Usage

-
$ role NAME --verb=verb --resource=resource.group/subresource [--resource-name=resourcename] [--dry-run]

+
$ expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]

 
Flags

 
@@ -2513,230 +2333,171 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
+
-
-
+
-
+
-
+
-
+
-
+
-
+
+
-
-
+
-
+
-
-
-
-
-

 
 
 
 
allow-missing-template-keyscluster-ip
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-run
 falseIf true, only print the object that would be sent, without sending it. ClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service. 
 

 
no-headerscontainer-port
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputo
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. Synonym for --target-port 
 

 
output-versiondry-run
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, only print the object that would be sent, without sending it. 
 

 
resourceexternal-ip
 []Resource that the rule applies to Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. 
 

 
resource-namefilenamef
 []Resource in the white list that the rule applies to, repeat this flag for multiple items Filename, directory, or URL to files identifying the resource to expose a service 
 

 
save-configgenerator
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) service/v2The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. 
 

 
show-labelslabelsl
 falseWhen printing, show all labels as the last column (default hide labels column) Labels to apply to the service created by this call. 
 

 
sort-byload-balancer-ip
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. IP to assign to the LoadBalancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). 
 

 
templatename
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. The name for the newly created object. 
 

 
validateoutputo
 trueIf true, use a schema to validate the input before sending it Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
verboverrides
 []Verb that applies to the resources contained in the rule 

-

-
rolebinding

-

-
 Create a RoleBinding for user1, user2, and group1 using the admin ClusterRole

-

-
kubectl create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
-

-
Create a RoleBinding for a particular Role or ClusterRole.

-
Usage

-
$ rolebinding NAME --clusterrole=NAME|--role=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
-
+
-
+
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
-
-
-
-
-
-
+
NameShorthandDefaultUsage
allow-missing-template-keys
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
 

 
clusterroleport
 
 ClusterRole this RoleBinding should reference The port that the service should serve on. Copied from the resource being exposed, if unspecified 
 

 
dry-runprotocol
 falseIf true, only print the object that would be sent, without sending it. 
generator
 rolebinding.rbac.authorization.k8s.io/v1alpha1The name of the API generator to use. The network protocol for the service to be created. Default is 'TCP'. 
 

 
grouprecord
 []Groups to bind to the role falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
no-headersrecursiveR
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
outputosave-config
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
output-versionselector
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set.) 
 

 
rolesession-affinity
 
 Role this RoleBinding should reference 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
serviceaccount[]Service accounts to bind to the role, in the format : 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' 
 

 
sort-bytarget-port
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Name or number for the port on the container that the service should direct traffic to. Optional. 
 

 
templatetype
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
validate
 trueIf true, use a schema to validate the input before sending it Type for this service: ClusterIP, NodePort, LoadBalancer, or ExternalName. Default is 'ClusterIP'. 
 

 
 

 

-
secret

-
Create a secret using specified subcommand.

-
Usage

-
$ secret

-

-
secret docker-registry

+
delete

 

-
 If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:

+
 Delete a pod using the type and name specified in pod.json.

 

-
kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
+
kubectl delete -f ./pod.json
+

+

+
 Delete a pod based on the type and name in the JSON passed into stdin.

+

+
cat pod.json | kubectl delete -f -
+

+

+
 Delete pods and services with same names "baz" and "foo"

+

+
kubectl delete pod,service baz foo
+

+

+
 Delete pods and services with label name=myLabel.

+

+
kubectl delete pods,services -l name=myLabel
+

+

+
 Delete a pod with minimal delay

+

+
kubectl delete pod foo --now
+

+

+
 Force delete a pod on a dead node

+

+
kubectl delete pod foo --grace-period=0 --force
+

+

+
 Delete all pods

+

+
kubectl delete pods --all
 

-
Create a new secret for use with Docker registries. 

-
Dockercfg secrets are used to authenticate against Docker registries. 

-
When using the Docker command line to push images, you can authenticate to a given registry by running: '$ docker login DOCKER REGISTRY SERVER --username=DOCKER USER --password=DOCKER PASSWORD --email=DOCKER _EMAIL'. 

-
  That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to

-
authenticate to the registry. The email address is optional. 

-
When creating applications, you may have a Docker registry that requires authentication.  In order for the nodes to pull images on your behalf, they have to have the credentials.  You can provide this information by creating a dockercfg secret and attaching it to your service account.

+
Delete resources by filenames, stdin, resources and names, or by resources and label selector. 

+
JSON and YAML formats are accepted. Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector. 

+
Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must pass a grace period of 0 and specify the --force flag. 

+
IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately. 

+
Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.

 
Usage

-
$ docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run]

+
$ delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])

 
Flags

 
@@ -2749,148 +2510,121 @@ 
Flags

-
-
-
-
-
-
-
+
-
+
-
-
+
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
-
+
+
-
+
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
append-hashall
 
 falseAppend a hash of the secret to its name. Delete all resources, including uninitialized ones, in the namespace of the specified resource types. 
 

 
docker-emailcascade
 Email for Docker registry trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 
docker-passwordfield-selector
 
 Password for Docker registry authentication Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 
docker-serverhttps://index.docker.io/v1/Server location for Docker registry filenamef[]containing the resource to delete. 
 

 
docker-usernameforce
 Username for Docker registry authentication falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
dry-rungrace-period
 falseIf true, only print the object that would be sent, without sending it. -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
generatorignore-not-found
 secret-for-docker-registry/v1The name of the API generator to use. falseTreat "resource not found" as a successful delete. Defaults to "true" when --all is specified. 
 

 
include-extended-apisinclude-uninitialized
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
no-headersnow
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, resources are signaled for immediate shutdown (same as --grace-period=1). 
 

 

 output
 o
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Output mode. Use "-o name" for shorter output (resource/name). 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
sort-byselectorl
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Selector (label query) to filter on, not including uninitialized ones. 
 

 
templatetimeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
validatewait
 
 trueIf true, use a schema to validate the input before sending it If true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

+
APP MANAGEMENT

+
This section contains commands for creating, updating, deleting, and
+viewing your workloads in a Kubernetes cluster.

 

-
secret generic

-

-
 Create a new secret named my-secret with keys for each file in folder bar

-

-
kubectl create secret generic my-secret --from-file=path/to/bar
-

+
apply

 

-
 Create a new secret named my-secret with specified keys instead of names on disk

+
 Apply the configuration in pod.json to a pod.

 

-
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub
+
kubectl apply -f ./pod.json
 

 

-
 Create a new secret named my-secret with key1=supersecret and key2=topsecret

+
 Apply the JSON passed into stdin to a pod.

 

-
kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
+
cat pod.json | kubectl apply -f -
 

 

-
 Create a new secret named my-secret using a combination of a file and a literal

+
 Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.

 

-
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-literal=passphrase=topsecret
+
kubectl apply --prune -f manifest.yaml -l app=nginx
 

 

-
 Create a new secret named my-secret from an env file

+
 Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.

 

-
kubectl create secret generic my-secret --from-env-file=path/to/bar.env
+
kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
 

-
Create a secret based on a file, directory, or specified literal value. 

-
A single secret may package one or more key/value pairs. 

-
When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key. 

-
When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

+
Apply a configuration to a resource by filename or stdin. The resource name must be specified. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. 

+
JSON and YAML formats are accepted. 

+
Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.

 
Usage

-
$ generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

+
$ apply -f FILENAME

 
Flags

 
@@ -2903,16 +2637,16 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
@@ -2921,34 +2655,34 @@ 
Flags

-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
@@ -2957,46 +2691,46 @@ 
Flags

-
-
+
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
-
+
-
+
+
@@ -3004,19 +2738,33 @@ 
Flags

+
+
+
+
+
+

 
 
 
 
allow-missing-template-keysall
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseSelect all resources in the namespace of the specified resource types. 
 

 
append-hashcascade
 falseAppend a hash of the secret to its name. trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
from-env-fileSpecify the path to a file to read lines of key=val pairs to create a secret (i.e. a Docker .env file). filenamef[]that contains the configuration to apply 
 

 
from-fileforce
 []Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used.  Specifying a directory will iterate each named file in the directory that is a valid secret key. falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
from-literalgrace-period
 []Specify a key and literal value to insert in secret (i.e. mykey=somevalue) -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
generatorinclude-uninitialized
 secret/v1The name of the API generator to use. falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
no-headersopenapi-patch
 falseWhen using the default or custom-column output format, don't print headers (default print headers). trueIf true, use openapi to calculate diff when the openapi presents and the resource can be found in the openapi spec. Otherwise, fall back to use baked-in types. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionoverwrite
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). trueAutomatically resolve conflicts between the modified and live configuration by using values from the modified configuration 
 

 
save-configprune
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. Automatically delete resource objects, including the uninitialized ones, that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) prune-whitelist[]Overwrite the default whitelist with  for --prune 
 

 
show-labelsrecord
 
 falseWhen printing, show all labels as the last column (default hide labels column) Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
typetimeout
 The type of secret to create 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 

 validate
 true
 If true, use a schema to validate the input before sending it 
 
waitfalseIf true, wait for resources to be gone before returning. This waits for finalizers. 

 
 

 

-
secret tls

+
edit-last-applied

 

-
 Create a new TLS secret named tls-secret with the given key pair:

+
 Edit the last-applied-configuration annotations by type/name in YAML.

 

-
kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
+
kubectl apply edit-last-applied deployment/nginx
 

-
Create a TLS secret from the given public/private key pair. 

-
The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key.

+

+
 Edit the last-applied-configuration annotations by file in JSON.

+

+
kubectl apply edit-last-applied -f deploy.yaml -o json
+

+
Edit the latest last-applied-configuration annotations of resources from the default editor. 

+
The edit-last-applied command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

+
The default format is YAML. To edit in JSON, specify "-o json". 

+
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

+
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

 
Usage

-
$ tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run]

+
$ edit-last-applied (RESOURCE/NAME | -f FILENAME)

 
Flags

 
@@ -3029,117 +2777,63 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
-
-
-
-
-
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
+
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
append-hashfalseAppend a hash of the secret to its name. 
certPath to PEM encoded public key certificate. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 
generatorsecret-for-tls/v1The name of the API generator to use. 
keyPath to private key associated with given certificate. filenamef[]Filename, directory, or URL to files to use to edit the resource 
 

 
no-headersinclude-uninitialized
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 

 output
 oOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). yamlOutput format. One of: yaml|json. 
 

 
save-configrecord
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
validatewindows-line-endings
 trueIf true, use a schema to validate the input before sending it falseDefaults to the line ending native to your platform. 
 

 
 

 

-
service

-
Create a service using specified subcommand.

-
Usage

-
$ service

-

-
service clusterip

+
set-last-applied

 

-
 Create a new ClusterIP service named my-cs

+
 Set the last-applied-configuration of a resource to match the contents of a file.

 

-
kubectl create service clusterip my-cs --tcp=5678:8080
+
kubectl apply set-last-applied -f deploy.yaml
 

 

-
 Create a new ClusterIP service named my-cs (in headless mode)

+
 Execute set-last-applied against each configuration file in a directory.

 

-
kubectl create service clusterip my-cs --clusterip="None"
+
kubectl apply set-last-applied -f path/
 

-
Create a ClusterIP service with the specified name.

+

+
 Set the last-applied-configuration of a resource to match the contents of a file, will create the annotation if it does not already exist.

+

+
kubectl apply set-last-applied -f deploy.yaml --create-annotation=true
+

+
Set the latest last-applied-configuration annotations by setting it to match the contents of a file. This results in the last-applied-configuration being updated as though 'kubectl apply -f ' was run, without updating any other parts of the object.

 
Usage

-
$ clusterip NAME [--tcp=<port>:<targetPort>] [--dry-run]

+
$ set-last-applied -f FILENAME

 
Flags

 
@@ -3152,16 +2846,10 @@ 
Flags

-
-
-
-
-
-
-
-
+
-
+
+
@@ -3170,16 +2858,10 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
+
+
+
+
@@ -3187,67 +2869,105 @@ 
Flags

+
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
clusteripcreate-annotation
 Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing). falseWill create 'last-applied-configuration' annotations if current objects doesn't have one 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
generatorservice-clusterip/v1The name of the API generator to use. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). filenamef[]Filename, directory, or URL to files that contains the last-applied-configuration annotations 
 

 

 output
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

+

+
view-last-applied

+

+
 View the last-applied-configuration annotations by type/name in YAML.

+

+
kubectl apply view-last-applied deployment/nginx
+

+

+
 View the last-applied-configuration annotations by file in JSON

+

+
kubectl apply view-last-applied -f deploy.yaml -o json
+

+
View the latest last-applied-configuration annotations by type/name or file. 

+
The default output will be printed to stdout in YAML format. One can use -o option to change output format.

+
Usage

+
$ view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FILENAME)

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
+

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). NameShorthandDefaultUsage
 

 
save-configall
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. Select all resources in the namespace of the specified resource types 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) filenamef[]Filename, directory, or URL to files that contains the last-applied-configuration annotations 
 

 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) outputoyamlOutput format. Must be one of yaml|json 
 

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
tcp[]Port pairs can be specified as ':'. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
 

 

-
service externalname

+
annotate

 

-
 Create a new ExternalName service named my-ns

+
 Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied

 

-
kubectl create service externalname my-ns --external-name bar.com
+
kubectl annotate pods foo description='my frontend'
 

-
Create an ExternalName service with the specified name. 

-
ExternalName service references to an external DNS address instead of only pods, which will allow application authors to reference services that exist off platform, on other clusters, or locally.

+

+
 Update a pod identified by type and name in "pod.json"

+

+
kubectl annotate -f pod.json description='my frontend'
+

+

+
 Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value.

+

+
kubectl annotate --overwrite pods foo description='my frontend running nginx'
+

+

+
 Update all pods in the namespace

+

+
kubectl annotate pods --all description='my frontend running nginx'
+

+

+
 Update pod 'foo' only if the resource is unchanged from version 1.

+

+
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
+

+

+
 Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the --overwrite flag.

+

+
kubectl annotate pods foo description-
+

+
Update the annotations on one or more resources 

+
All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data. 

+
Attempting to set an annotation that already exists will fail unless --overwrite is set. If --resource-version is specified and does not match the current resource version on the server the command will fail.

+
Use "kubectl api-resources" for a complete list of supported resources.

 
Usage

-
$ externalname NAME --external-name external.name [--dry-run]

+
$ annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

 
Flags

 
@@ -3260,10 +2980,10 @@ 
Flags

-
+
-
-
+
+
@@ -3272,22 +2992,28 @@ 
Flags

-
+
-
+
-
+
+
+
+
+
+
+
-
-
+
+
-
+
-
+
@@ -3296,65 +3022,53 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
+
-
+
-
+
+
-
-
+

 
 
 
 
allow-missing-template-keysall
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseSelect all resources, including uninitialized ones, in the namespace of the specified resource types. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
external-namefield-selector
 
 External name of service Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 
generatorfilenamef[]Filename, directory, or URL to files identifying the resource to update the annotation 
include-uninitialized
 service-externalname/v1The name of the API generator to use. falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
no-headerslocal
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, annotation will NOT contact api-server but run locally. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-configoverwrite
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. 
 

 
show-labelsrecord
 
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
tcp[]Port pairs can be specified as ':'. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
templateresource-version
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
 

 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). 
 

 
 

 

-
service loadbalancer

+
autoscale

 

-
 Create a new LoadBalancer service named my-lbs

+
 Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used:

 

-
kubectl create service loadbalancer my-lbs --tcp=5678:8080
+
kubectl autoscale deployment foo --min=2 --max=10
 

-
Create a LoadBalancer service with the specified name.

+

+
 Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%:

+

+
kubectl autoscale rc foo --max=5 --cpu-percent=80
+

+
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. 

+
Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.

 
Usage

-
$ loadbalancer NAME [--tcp=port:targetPort] [--dry-run]

+
$ autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU]

 
Flags

 
@@ -3367,10 +3081,10 @@ 
Flags

-
+
-
-
+
+
@@ -3379,83 +3093,83 @@ 
Flags

-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+

 
 
 
 
allow-missing-template-keyscpu-percent
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. -1The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
generatorservice-loadbalancer/v1The name of the API generator to use. filenamef[]Filename, directory, or URL to files identifying the resource to autoscale. 
 

 
no-headersgenerator
 falseWhen using the default or custom-column output format, don't print headers (default print headers). horizontalpodautoscaler/v1The name of the API generator to use. Currently there is only 1 generator. 
 

 
outputomax
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -1The upper limit for the number of pods that can be set by the autoscaler. Required. 
 

 
output-versionmin
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). -1The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. 
 

 
save-configname
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labels
 falseWhen printing, show all labels as the last column (default hide labels column) The name for the newly created object. If not specified, the name of the input resource will be used. 
 

 
sort-byoutputo
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
tcprecord
 []Port pairs can be specified as ':'. falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
validatesave-config
 trueIf true, use a schema to validate the input before sending it falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
 

 

-
service nodeport

+
convert

 

-
 Create a new NodePort service named my-ns

+
 Convert 'pod.yaml' to latest version and print to stdout.

 

-
kubectl create service nodeport my-ns --tcp=5678:8080
+
kubectl convert -f pod.yaml
 

-
Create a NodePort service with the specified name.

+

+
 Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in JSON format.

+

+
kubectl convert -f pod.yaml --local -o json
+

+

+
 Convert all files under current directory to latest version and create them all.

+

+
kubectl convert -f . | kubectl create -f -
+

+
Convert config files between different API versions. Both YAML and JSON formats are accepted. 

+
The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version. 

+
The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.

 
Usage

-
$ nodeport NAME [--tcp=port:targetPort] [--dry-run]

+
$ convert -f FILENAME

 
Flags

 
@@ -3468,82 +3182,34 @@ 
Flags

-
+
+
+
+
+
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -3554,15 +3220,35 @@ 
Flags

 
 
 
 
allow-missing-template-keysfilenamef[]Filename, directory, or URL to files to need to get converted. 
local
 
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. If true, convert will NOT try to contact api-server but run locally. 
 

 
dry-runfalseIf true, only print the object that would be sent, without sending it. outputoyamlOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
generatoroutput-version
 service-nodeport/v1The name of the API generator to use. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
node-port0Port used to expose the service on each node in a cluster. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-config
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Output the formatted object with the given group version (for ex: 'extensions/v1beta1').) 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
tcp[]Port pairs can be specified as ':'. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 

 validate
 

 

 

-
serviceaccount

+
edit

 

-
 Create a new service account named my-service-account

+
 Edit the service named 'docker-registry':

 

-
kubectl create serviceaccount my-service-account
+
kubectl edit svc/docker-registry
 

-
Create a service account with the specified name.

+

+
 Use an alternative editor

+

+
KUBE_EDITOR="nano" kubectl edit svc/docker-registry
+

+

+
 Edit the job 'myjob' in JSON using the v1 API format:

+

+
kubectl edit job.v1.batch/myjob -o json
+

+

+
 Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation:

+

+
kubectl edit deployment/mydeployment -o yaml --save-config
+

+
Edit a resource from the default editor. 

+
The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

+
Editing is done with the API version used to fetch the resource. To edit using a specific API version, fully-qualify the resource, version, and group. 

+
The default format is YAML. To edit in JSON, specify "-o json". 

+
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

+
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

 
Usage

-
$ serviceaccount NAME [--dry-run]

+
$ edit (RESOURCE/NAME | -f FILENAME)

 
Flags

 
@@ -3575,34 +3261,16 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
+
-
+
@@ -3611,40 +3279,28 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
@@ -3652,52 +3308,55 @@ 
Flags

+
+
+
+
+
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 
generatorserviceaccount/v1The name of the API generator to use. 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] filenamef[]Filename, directory, or URL to files to use to edit the resource 
 

 
no-headersinclude-uninitialized
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-configoutput-patch
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Output the patch if the resource is edited. 
 

 
show-labelsrecord
 
 falseWhen printing, show all labels as the last column (default hide labels column) Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
templatesave-config
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 

 validate
 true
 If true, use a schema to validate the input before sending it 
 
windows-line-endingsfalseDefaults to the line ending native to your platform. 

 
 

 

-
delete

-

-
 Delete a pod using the type and name specified in pod.json.

-

-
kubectl delete -f ./pod.json
-

+
label

 

-
 Delete a pod based on the type and name in the JSON passed into stdin.

+
 Update pod 'foo' with the label 'unhealthy' and the value 'true'.

 

-
cat pod.json | kubectl delete -f -
+
kubectl label pods foo unhealthy=true
 

 

-
 Delete pods and services with same names "baz" and "foo"

+
 Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.

 

-
kubectl delete pod,service baz foo
+
kubectl label --overwrite pods foo status=unhealthy
 

 

-
 Delete pods and services with label name=myLabel.

+
 Update all pods in the namespace

 

-
kubectl delete pods,services -l name=myLabel
+
kubectl label pods --all status=unhealthy
 

 

-
 Delete a pod with minimal delay

+
 Update a pod identified by the type and name in "pod.json"

 

-
kubectl delete pod foo --now
+
kubectl label -f pod.json status=unhealthy
 

 

-
 Force delete a pod on a dead node

+
 Update pod 'foo' only if the resource is unchanged from version 1.

 

-
kubectl delete pod foo --grace-period=0 --force
+
kubectl label pods foo status=unhealthy --resource-version=1
 

 

-
 Delete all pods

+
 Update pod 'foo' by removing a label named 'bar' if it exists. # Does not require the --overwrite flag.

 

-
kubectl delete pods --all
+
kubectl label pods foo bar-
 

-
Delete resources by filenames, stdin, resources and names, or by resources and label selector. 

-
JSON and YAML formats are accepted. Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector. 

-
Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must pass a grace period of 0 and specify the --force flag. 

-
IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately. 

-
Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.

+
Update the labels on a resource. 

+
    
+
  • A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters each.  
    • 
+
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
+
  • If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.  
    • 
+
  • If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
    • 
+

 
Usage

-
$ delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])

+
$ label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

 
Flags

 
@@ -3713,61 +3372,61 @@ 
Flags

-
+
-
+
-
-
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
+
+
-
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
+
@@ -3776,49 +3435,51 @@ 
Flags

-
-
+
-
+
+
-
+
+
-
-
+

 
 
all
 
 falseDelete all resources, including uninitialized ones, in the namespace of the specified resource types. Select all resources, including uninitialized ones, in the namespace of the specified resource types 
 

 
cascadedry-run
 trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. falseIf true, only print the object that would be sent, without sending it. 
field-selectorSelector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 

 filename
 f
 []Filename, directory, or URL to files containing the resource to delete. Filename, directory, or URL to files identifying the resource to update the labels 
 

 
forceinclude-uninitialized
 
 falseImmediate deletion of some resources may result in inconsistency or data loss and requires confirmation. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
grace-periodlist
 -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. falseIf true, display the labels for a given resource. 
 

 
ignore-not-foundlocal
 
 falseTreat "resource not found" as a successful delete. Defaults to "true" when --all is specified. If true, label will NOT contact api-server but run locally. 
 

 
include-extended-apisoutputo
 trueIf true, include definitions of new APIs via calls to the API server. [default true] Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
include-uninitializedoverwrite
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. 
 

 
nowrecord
 
 falseIf true, resources are signaled for immediate shutdown (same as --grace-period=1). 
outputoOutput mode. Use "-o name" for shorter output (resource/name). Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 

 recursive
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
selectorlresource-version
 Selector (label query) to filter on, not including uninitialized ones. If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
 

 
timeoutselectorl
 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). 
 

 
 

 

-
edit

+
patch

 

-
 Edit the service named 'docker-registry':

+
 Partially update a node using a strategic merge patch. Specify the patch as JSON.

 

-
kubectl edit svc/docker-registry
+
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
 

 

-
 Use an alternative editor

+
 Partially update a node using a strategic merge patch. Specify the patch as YAML.

 

-
KUBE_EDITOR="nano" kubectl edit svc/docker-registry
+
kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
 

 

-
 Edit the job 'myjob' in JSON using the v1 API format:

+
 Partially update a node identified by the type and name specified in "node.json" using strategic merge patch.

 

-
kubectl edit job.v1.batch/myjob -o json
+
kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
 

 

-
 Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation:

+
 Update a container's image; spec.containers[*].name is required because it's a merge key.

 

-
kubectl edit deployment/mydeployment -o yaml --save-config
+
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
 

-
Edit a resource from the default editor. 

-
The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

-
Editing is done with the API version used to fetch the resource. To edit using a specific API version, fully-qualify the resource, version, and group. 

-
The default format is YAML. To edit in JSON, specify "-o json". 

-
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

-
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

+

+
 Update a container's image using a json patch with positional arrays.

+

+
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
+

+
Update field(s) of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. 

+
JSON and YAML formats are accepted. 

+
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

 
Usage

-
$ edit (RESOURCE/NAME | -f FILENAME)

+
$ patch (-f FILENAME | TYPE NAME) -p PATCH

 
Flags

 
@@ -3831,34 +3492,34 @@ 
Flags

+
+
+
+
+
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
+
-
-
+
@@ -3873,118 +3534,41 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+

 
 
 
 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files to use to edit the resource 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] Filename, directory, or URL to files identifying the resource to update 
 

 
include-uninitializedlocal
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. If true, patch will operate on the content of the file, not the server-side resource. 
 

 

 output
 oyamlOutput format. One of: yaml|json. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-patchpatchp
 falseOutput the patch if the resource is edited. The patch to be applied to the resource JSON file. 
 

 

 record
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
validatetrueIf true, use a schema to validate the input before sending it 
windows-line-endingstype
 falseDefaults to the line ending native to your platform. strategicThe type of patch being provided; one of [json merge strategic] 
 

 
 

 

-
get

-

-
 List all pods in ps output format.

-

-
kubectl get pods
-

-

-
 List all pods in ps output format with more information (such as node name).

-

-
kubectl get pods -o wide
-

-

-
 List a single replication controller with specified NAME in ps output format.

-

-
kubectl get replicationcontroller web
-

-

-
 List a single pod in JSON output format.

-

-
kubectl get -o json pod web-pod-13je7
-

-

-
 List a pod identified by type and name specified in "pod.yaml" in JSON output format.

-

-
kubectl get -f pod.yaml -o json
-

+
replace

 

-
 Return only the phase value of the specified pod.

+
 Replace a pod using the data in pod.json.

 

-
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
+
kubectl replace -f ./pod.json
 

 

-
 List all replication controllers and services together in ps output format.

+
 Replace a pod based on the JSON passed into stdin.

 

-
kubectl get rc,services
+
cat pod.json | kubectl replace -f -
 

 

-
 List one or more resources by their type and names.

+
 Update a single-container pod's image version (tag) to v4

 

-
kubectl get rc/web service/frontend pods/web-pod-13je7
+
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
 

 

-
 List all resources with different types.

+
 Force replace, delete and then re-create the resource

 

-
kubectl get all
+
kubectl replace --force -f ./pod.json
 

-
Display one or many resources 

-
Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in your current namespace unless you pass --all-namespaces. 

-
Uninitialized objects are not shown unless --include-uninitialized is passed. 

-
By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

+
Replace a resource by filename or stdin. 

+
JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by 

+
  $ kubectl get TYPE NAME -o yaml

+
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

 
Usage

-
$ get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags]

+
$ replace -f FILENAME

 
Flags

 
@@ -3997,76 +3581,28 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
@@ -4075,120 +3611,73 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
+
-
-
-
-
-
-
-
+
-
+
-
+

 
 
 
 
all-namespacesfalseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
allow-missing-template-keyscascade
 
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
chunk-size500Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future. 
experimental-server-printfalseIf true, have the server return the appropriate table output. Supports extension APIs and CRD. Experimental. 
exportfalseIf true, use 'export' for the resources.  Exported resources are stripped of cluster-specific information. 
field-selectorSelector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to get from a server. 
ignore-not-foundfalseIf the requested object does not exist the command will return exit code 0. 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] to use to replace the resource. 
 

 
include-uninitializedforce
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
label-columnsL[]Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... Only used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
no-headersgrace-period
 falseWhen using the default or custom-column output format, don't print headers (default print headers). -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
rawRaw URI to request from the server.  Uses the transport specified by the kubeconfig file. 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-kindfalseIf present, list the resource type for the requested object(s). 
show-labelssave-config
 
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
templatetimeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
use-openapi-print-columnsvalidate
 
 trueIf true, use x-kubernetes-print-column metadata (if present) from the OpenAPI schema for displaying a resource. 
watchwfalseAfter listing/getting the requested object, watch for changes. Uninitialized objects are excluded if no object name is provided. If true, use a schema to validate the input before sending it 
 

 
watch-onlywait
 
 falseWatch for changes to the requested object(s), without listing/getting first. If true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

 

-
label

+
rollout

 

-
 Update pod 'foo' with the label 'unhealthy' and the value 'true'.

+
 Rollback to the previous deployment

 

-
kubectl label pods foo unhealthy=true
+
kubectl rollout undo deployment/abc
 

 

-
 Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.

+
 Check the rollout status of a daemonset

 

-
kubectl label --overwrite pods foo status=unhealthy
-

-

-
 Update all pods in the namespace

-

-
kubectl label pods --all status=unhealthy
-

-

-
 Update a pod identified by the type and name in "pod.json"

-

-
kubectl label -f pod.json status=unhealthy
+
kubectl rollout status daemonset/foo
 

+
Manage the rollout of a resource.

+
Valid resource types include: 

+
    
+
  • deployments  
    • 
+
  • daemonsets  
    • 
+
  • statefulsets
    • 
+

+
Usage

+
$ rollout SUBCOMMAND

+

+
history

 

-
 Update pod 'foo' only if the resource is unchanged from version 1.

+
 View the rollout history of a deployment

 

-
kubectl label pods foo status=unhealthy --resource-version=1
+
kubectl rollout history deployment/abc
 

 

-
 Update pod 'foo' by removing a label named 'bar' if it exists. # Does not require the --overwrite flag.

+
 View the details of daemonset revision 3

 

-
kubectl label pods foo bar-
+
kubectl rollout history daemonset/abc --revision=3
 

-
Update the labels on a resource. 

-
    
-
  • A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters each.  
    • 
-
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
-
  • If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.  
    • 
-
  • If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
    • 
-

+
View previous rollout revisions and configurations.

 
Usage

-
$ label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

+
$ history (TYPE NAME | TYPE/NAME) [flags]

 
Flags

 
@@ -4201,82 +3690,88 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
+
-
-
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to update the labels 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
listrecursiveR
 falseIf true, display the labels for a given resource. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
localrevision
 falseIf true, label will NOT contact api-server but run locally. 0See the details, including podTemplate of the revision specified 
 

+

+
pause

+

+
 Mark the nginx deployment as paused. Any current state of # the deployment will continue its function, new updates to the deployment will not # have an effect as long as the deployment is paused.

+

+
kubectl rollout pause deployment/nginx
+

+
Mark the provided resource as paused 

+
Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused.

+
Usage

+
$ pause RESOURCE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
+
+

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). NameShorthandDefaultUsage
 

 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

+

+
resume

+

+
 Resume an already paused deployment

+

+
kubectl rollout resume deployment/nginx
+

+
Resume a paused resource 

+
Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. Currently only deployments support being resumed.

+
Usage

+
$ resume RESOURCE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
@@ -4284,76 +3779,76 @@ 
Flags

+
+

 
overwritefalseIf true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. NameShorthandDefaultUsage
 

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 

 recursive
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

+

+
status

+

+
 Watch the rollout status of a deployment

+

+
kubectl rollout status deployment/nginx
+

+
Show the status of the rollout. 

+
By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.

+
Usage

+
$ status (TYPE NAME | TYPE/NAME) [flags]

+
Flags

+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
-
+
-
+
+
-
-
-
-
+
+
+
+

 
resource-versionIf non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
selectorlSelector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). NameShorthandDefaultUsage
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
sort-byrevision
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 0Pin to a specific revision for showing its status. Defaults to 0 (last revision). 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. watchwtrueWatch the status of the rollout until it's done. 
 

 
 

 

-
patch

-

-
 Partially update a node using a strategic merge patch. Specify the patch as JSON.

-

-
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
-

-

-
 Partially update a node using a strategic merge patch. Specify the patch as YAML.

-

-
kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
-

+
undo

 

-
 Partially update a node identified by the type and name specified in "node.json" using strategic merge patch.

+
 Rollback to the previous deployment

 

-
kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
+
kubectl rollout undo deployment/abc
 

 

-
 Update a container's image; spec.containers[*].name is required because it's a merge key.

+
 Rollback to daemonset revision 3

 

-
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
+
kubectl rollout undo daemonset/abc --to-revision=3
 

 

-
 Update a container's image using a json patch with positional arrays.

+
 Rollback to the previous deployment with dry-run

 

-
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
+
kubectl rollout undo --dry-run=true deployment/abc
 

-
Update field(s) of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. 

-
JSON and YAML formats are accepted. 

-
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

+
Rollback to a previous rollout.

 
Usage

-
$ patch (-f FILENAME | TYPE NAME) -p PATCH

+
$ undo (TYPE NAME | TYPE/NAME) [flags]

 
Flags

 
@@ -4366,58 +3861,16 @@ 
Flags

-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -4426,65 +3879,45 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+

 
 
 
 
allow-missing-template-keysdry-run
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseIf true, only print the object that would be sent, without sending it. 
 

 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to update 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 
localfalseIf true, patch will operate on the content of the file, not the server-side resource. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
patchpThe patch to be applied to the resource JSON file. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. Filename, directory, or URL to files identifying the resource to get from a server. 
 

 

 recursive
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
typeto-revision
 strategicThe type of patch being provided; one of [json merge strategic] 0The revision to rollback to. Default to 0 (last revision). 
 

 
 

 

-
replace

+
scale

 

-
 Replace a pod using the data in pod.json.

+
 Scale a replicaset named 'foo' to 3.

 

-
kubectl replace -f ./pod.json
+
kubectl scale --replicas=3 rs/foo
 

 

-
 Replace a pod based on the JSON passed into stdin.

+
 Scale a resource identified by type and name specified in "foo.yaml" to 3.

 

-
cat pod.json | kubectl replace -f -
+
kubectl scale --replicas=3 -f foo.yaml
 

 

-
 Update a single-container pod's image version (tag) to v4

+
 If the deployment named mysql's current size is 2, scale mysql to 3.

 

-
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
+
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
 

 

-
 Force replace, delete and then re-create the resource

+
 Scale multiple replication controllers.

 

-
kubectl replace --force -f ./pod.json
+
kubectl scale --replicas=5 rc/foo rc/bar rc/baz
 

-
Replace a resource by filename or stdin. 

-
JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by 

-
  $ kubectl get TYPE NAME -o yaml

-
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

+

+
 Scale statefulset named 'web' to 3.

+

+
kubectl scale --replicas=3 statefulset/web
+

+
Set a new size for a Deployment, ReplicaSet, Replication Controller, or StatefulSet. 

+
Scale also allows users to specify one or more preconditions for the scale action. 

+
If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.

 
Usage

-
$ replace -f FILENAME

+
$ scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)

 
Flags

 
@@ -4497,40 +3930,28 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
@@ -4545,57 +3966,101 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
+
+
+
+
+
+

 
 
 
 
cascadefalseOnly relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). 
filenamef[]Filename, directory, or URL to files to use to replace the resource. 
forceall
 
 falseDelete and re-create the specified resource Select all resources in the namespace of the specified resource types 
 

 
grace-periodcurrent-replicas
 
 -1Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. Precondition for current size. Requires that the current size of the resource match this value in order to scale. 
 

 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] filenamef[]Filename, directory, or URL to files identifying the resource to set a new size 
 

 

 output
 o
 Output mode. Use "-o name" for shorter output (resource/name). Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 record
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
save-configreplicas
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 0The new desired number of replicas. Required. 
 

 
timeoutresource-version
 0sOnly relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). Precondition for resource version. Requires that the current resource version match this value in order to scale. 
 

 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
timeout0sThe length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). 
 

 
 

 

-
rolling-update

+
set

+
Configure application resources 

+
These commands help you make changes to existing application resources.

+
Usage

+
$ set SUBCOMMAND

+

+
env

 

-
 Update pods of frontend-v1 using new replication controller data in frontend-v2.json.

+
 Update deployment 'registry' with a new environment variable

 

-
kubectl rolling-update frontend-v1 -f frontend-v2.json
+
kubectl set env deployment/registry STORAGE_DIR=/local
 

 

-
 Update pods of frontend-v1 using JSON data passed into stdin.

+
 List the environment variables defined on a deployments 'sample-build'

 

-
cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
+
kubectl set env deployment/sample-build --list
 

 

-
 Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the # name of the replication controller.

+
 List the environment variables defined on all pods

 

-
kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2
+
kubectl set env pods --all --list
 

 

-
 Update the pods of frontend by just changing the image, and keeping the old name.

+
 Output modified deployment in YAML, and does not alter the object on the server

 

-
kubectl rolling-update frontend --image=image:v2
+
kubectl set env deployment/sample-build STORAGE_DIR=/data -o yaml
 

 

-
 Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2).

+
 Update all containers in all replication controllers in the project to have ENV=prod

 

-
kubectl rolling-update frontend-v1 frontend-v2 --rollback
+
kubectl set env rc --all ENV=prod
 

-
Perform a rolling update of the given ReplicationController. 

-
Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the new PodTemplate. The new-controller.json must specify the same namespace as the existing replication controller and overwrite at least one (common) label in its replicaSelector. 

-
! http://kubernetes.io/images/docs/kubectl_rollingupdate.svg

+

+
 Import environment from a secret

+

+
kubectl set env --from=secret/mysecret deployment/myapp
+

+

+
 Import environment from a config map with a prefix

+

+
kubectl set env --from=configmap/myconfigmap --prefix=MYSQL_ deployment/myapp
+

+

+
 Import specific keys from a config map

+

+
kubectl set env --keys=my-example-key --from=configmap/myconfigmap deployment/myapp
+

+

+
 Remove the environment variable ENV from container 'c1' in all deployment configs

+

+
kubectl set env deployments --all --containers="c1" ENV-
+

+

+
 Remove the environment variable ENV from a deployment definition on disk and # update the deployment config on the server

+

+
kubectl set env -f deploy.json ENV-
+

+

+
 Set some of the local shell environment into a deployment config on the server

+

+
env | grep RAILS_ | kubectl set env -e - deployment/registry
+

+
Update environment variables on a pod template. 

+
List environment variable definitions in one or more pods, pod templates. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations). View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. 

+
If "--env -" is passed, environment variables can be read from STDIN using the standard env syntax. 

+
Possible resources include (case insensitive): 

+
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)

 
Usage

-
$ rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)

+
$ env RESOURCE/NAME KEY_1=VAL_1 ... KEY_N=VAL_N

 
Flags

 
@@ -4608,22 +4073,16 @@ 
Flags

-
-
-
-
-
-
-
-
+
-
+
+
-
-
-
-
+
+
+
+
@@ -4632,34 +4091,40 @@ 
Flags

+
+
+
+
+
+
-
+
-
+
-
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
-
+
@@ -4668,103 +4133,64 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
+
-
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
containerall
 Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod falseIf true, select all resources in the namespace of the specified resource types 
 

 
deployment-label-keydeploymentThe key to use to differentiate between two different controllers, default 'deployment'.  Only relevant when --image is specified, ignored otherwise containersc*The names of containers in the selected pod templates to change - may use wildcards 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
enve[]Specify a key-value pair for an environment variable to set into each container. 

 filename
 f
 []Filename or URL to file to use to create the new replication controller. Filename, directory, or URL to files the resource to update the env 
 

 
imagefrom
 
 Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag).  Can not be used with --filename/-f The name of a resource from which to inject environment variables 
 

 
image-pull-policykeys
 Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. []Comma-separated list of keys to import from specified resource 
 

 
include-extended-apislist
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseIf true, display the environment and any changes in the standard format. this flag will removed when we have kubectl view env. 
 

 
no-headerslocal
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, set env will NOT contact api-server but run locally. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
poll-interval3sTime delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
rollbackoverwrite
 falseIf true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout 
show-alla
 trueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. If true, allow environment to be overwritten, otherwise reject updates that overwrite existing environment. 
 

 
templateprefix
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Prefix to append to variable names 
 

 
timeout5m0sMax time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
update-periodresolve
 1m0sTime to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". falseIf true, show secret or configmap references when listing variables 
 

 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on 
 

 
 

 

-
rollout

+
image

 

-
 Rollback to the previous deployment

+
 Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'.

 

-
kubectl rollout undo deployment/abc
+
kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
 

 

-
 Check the rollout status of a daemonset

+
 Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'

 

-
kubectl rollout status daemonset/foo
+
kubectl set image deployments,rc nginx=nginx:1.9.1 --all
 

-
Manage the rollout of a resource.

-
Valid resource types include: 

-
    
-
  • deployments  
    • 
-
  • daemonsets  
    • 
-
  • statefulsets
    • 
-

-
Usage

-
$ rollout SUBCOMMAND

-

-
history

 

-
 View the rollout history of a deployment

+
 Update image of all containers of daemonset abc to 'nginx:1.9.1'

 

-
kubectl rollout history deployment/abc
+
kubectl set image daemonset abc *=nginx:1.9.1
 

 

-
 View the details of daemonset revision 3

+
 Print result (in yaml format) of updating nginx container image from local file, without hitting the server

 

-
kubectl rollout history daemonset/abc --revision=3
+
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
 

-
View previous rollout revisions and configurations.

+
Update existing container image(s) of resources. 

+
Possible resources include (case insensitive): 

+
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), replicaset (rs)

 
Usage

-
$ history (TYPE NAME | TYPE/NAME) [flags]

+
$ image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N

 
Flags

 
@@ -4777,36 +4203,88 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
-
-
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []
 Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
localfalseIf true, set image will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
revisionselectorl
 0See the details, including podTemplate of the revision specified Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
 

 

-
pause

+
resources

 

-
 Mark the nginx deployment as paused. Any current state of # the deployment will continue its function, new updates to the deployment will not # have an effect as long as the deployment is paused.

+
 Set a deployments nginx container cpu limits to "200m" and memory to "512Mi"

 

-
kubectl rollout pause deployment/nginx
+
kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
 

-
Mark the provided resource as paused 

-
Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused.

+

+
 Set the resource request and limits for all containers in nginx

+

+
kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
+

+

+
 Remove the resource requests for resources on containers in nginx

+

+
kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0
+

+

+
 Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server

+

+
kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
+

+
Specify compute resource requirements (cpu, memory) for any resource that defines a pod template.  If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits. 

+
for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit. 

+
Possible resources include (case insensitive): Use "kubectl api-resources" for a complete list of supported resources..

 
Usage

-
$ pause RESOURCE

+
$ resources (-f FILENAME | TYPE NAME)  ([--limits=LIMITS & --requests=REQUESTS]

 
Flags

 
@@ -4819,30 +4297,91 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
containersc*The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []
 Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
limitsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
localfalseIf true, set resources will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 
requestsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
selectorlSelector (label query) to filter on, not including uninitialized ones,supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

 
 

 

-
resume

+
selector

 

-
 Resume an already paused deployment

+
 set the labels and selector before creating a deployment/service pair.

 

-
kubectl rollout resume deployment/nginx
+
kubectl create service clusterip my-svc --clusterip="None" -o yaml --dry-run | kubectl set selector --local -f - 'environment=qa' -o yaml | kubectl create -f -
+kubectl create deployment my-dep -o yaml --dry-run | kubectl label --local -f - environment=qa -o yaml | kubectl create -f -
 

-
Resume a paused resource 

-
Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. Currently only deployments support being resumed.

+
Set the selector on a resource. Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of 'set selector'. 

+
A selector must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. Note: currently selectors can only be set on Service objects.

 
Usage

-
$ resume RESOURCE

+
$ selector (-f FILENAME | TYPE NAME) EXPRESSIONS [--resource-version=version]

 
Flags

 
@@ -4855,30 +4394,78 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources in the namespace of the specified resource types 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to get from a server. identifying the resource. 
 

 
recursiveRinclude-uninitialized
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 
localfalseIf true, annotation will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRtrueProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
resource-versionIf non-empty, the selectors update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 

 

 

-
status

+
serviceaccount

 

-
 Watch the rollout status of a deployment

+
 Set Deployment nginx-deployment's ServiceAccount to serviceaccount1

 

-
kubectl rollout status deployment/nginx
+
kubectl set serviceaccount deployment nginx-deployment serviceaccount1
 

-
Show the status of the rollout. 

-
By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.

+

+
 Print the result (in yaml format) of updated nginx deployment with serviceaccount from local file, without hitting apiserver

+

+
kubectl set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
+

+
Update ServiceAccount of pod template resources. 

+
Possible resources (case insensitive) can be: 

+
replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset

 
Usage

-
$ status (TYPE NAME | TYPE/NAME) [flags]

+
$ serviceaccount (-f FILENAME | TYPE NAME) SERVICE_ACCOUNT

 
Flags

 
@@ -4891,51 +4478,75 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []
 Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
recursiveRinclude-uninitialized
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
revisionlocal
 0Pin to a specific revision for showing its status. Defaults to 0 (last revision). falseIf true, set serviceaccount will NOT contact api-server but run locally. 
 

 
watchwtrueWatch the status of the rollout until it's done. outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
 

 

-
undo

+
subject

 

-
 Rollback to the previous deployment

+
 Update a ClusterRoleBinding for serviceaccount1

 

-
kubectl rollout undo deployment/abc
+
kubectl set subject clusterrolebinding admin --serviceaccount=namespace:serviceaccount1
 

 

-
 Rollback to daemonset revision 3

+
 Update a RoleBinding for user1, user2, and group1

 

-
kubectl rollout undo daemonset/abc --to-revision=3
+
kubectl set subject rolebinding admin --user=user1 --user=user2 --group=group1
 

 

-
 Rollback to the previous deployment with dry-run

+
 Print the result (in yaml format) of updating rolebinding subjects from a local, without hitting the server

 

-
kubectl rollout undo --dry-run=true deployment/abc
+
kubectl create rolebinding admin --role=admin --user=admin -o yaml --dry-run | kubectl set subject --local -f - --user=foo -o yaml
 

-
Rollback to a previous rollout.

+
Update User, Group or ServiceAccount in a RoleBinding/ClusterRoleBinding.

 
Usage

-
$ undo (TYPE NAME | TYPE/NAME) [flags]

+
$ subject (-f FILENAME | TYPE NAME) [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

 
Flags

 
@@ -4948,6 +4559,12 @@ 
Flags

+
+
+
+
+
+
@@ -4957,7 +4574,31 @@ 
Flags

-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -4966,45 +4607,23 @@ 
Flags

-
+
+
-
-
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 

 dry-run
 
 false
 filename
 f
 []Filename, directory, or URL to files identifying the resource to get from a server. Filename, directory, or URL to files the resource to update the subjects 
group[]Groups to bind to the role 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
localfalseIf true, set subject will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 recursive
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
to-revisionselectorl
 0The revision to rollback to. Default to 0 (last revision). Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
serviceaccount[]Service accounts to bind to the role 
 

 
 

 

-
scale

-

-
 Scale a replicaset named 'foo' to 3.

-

-
kubectl scale --replicas=3 rs/foo
-

-

-
 Scale a resource identified by type and name specified in "foo.yaml" to 3.

-

-
kubectl scale --replicas=3 -f foo.yaml
-

-

-
 If the deployment named mysql's current size is 2, scale mysql to 3.

-

-
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
-

-

-
 Scale multiple replication controllers.

-

-
kubectl scale --replicas=5 rc/foo rc/bar rc/baz
-

-

-
 Scale statefulset named 'web' to 3.

-

-
kubectl scale --replicas=3 statefulset/web
-

-
Set a new size for a Deployment, ReplicaSet, Replication Controller, or StatefulSet. 

-
Scale also allows users to specify one or more preconditions for the scale action. 

-
If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.

+
wait

 
Usage

-
$ scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)

+
$ wait resource.group/name [--for=delete|--for condition=available]

 
Flags

 
@@ -5017,60 +4636,36 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
@@ -5079,76 +4674,122 @@ 
Flags

-
-
+
+

 
 
 
 
allall-namespaces
 
 falseSelect all resources in the namespace of the specified resource types 
current-replicas-1Precondition for current size. Requires that the current size of the resource match this value in order to scale. If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
 

 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to set a new size identifying the resource. 
 

 
include-extended-apisfor
 trueIf true, include definitions of new APIs via calls to the API server. [default true] The condition to wait on: [delete|condition=condition-name]. 
 

 

 output
 o
 Output mode. Use "-o name" for shorter output (resource/name). 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 recursive
 Rfalsetrue
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
replicas-1The new desired number of replicas. Required. 
resource-versionPrecondition for resource version. Requires that the current resource version match this value in order to scale. 

 selector
 l
 
 

 timeout
 0sThe length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). 30sThe length of time to wait before giving up.  Zero means check once and don't wait, negative means wait for a week. 
 

 
 

+
WORKING WITH APPS

+
This section contains commands for inspecting and debugging your
+applications.

+
    
+
  • logs will print the logs from the specified pod + container.
    • 
+
  • exec can be used to get an interactive shell on a pod + container.
    • 
+
  • describe will print debug information about the given resource.
    • 
+

 

-
set

-
Configure application resources 

-
These commands help you make changes to existing application resources.

-
Usage

-
$ set SUBCOMMAND

-

-
env

+
attach

 

-
 Update deployment 'registry' with a new environment variable

+
 Get output from running pod 123456-7890, using the first container by default

 

-
kubectl set env deployment/registry STORAGE_DIR=/local
+
kubectl attach 123456-7890
 

 

-
 List the environment variables defined on a deployments 'sample-build'

+
 Get output from ruby-container from pod 123456-7890

 

-
kubectl set env deployment/sample-build --list
+
kubectl attach 123456-7890 -c ruby-container
 

 

-
 List the environment variables defined on all pods

+
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

 

-
kubectl set env pods --all --list
+
kubectl attach 123456-7890 -c ruby-container -i -t
 

 

-
 Output modified deployment in YAML, and does not alter the object on the server

+
 Get output from the first pod of a ReplicaSet named nginx

 

-
kubectl set env deployment/sample-build STORAGE_DIR=/data -o yaml
+
kubectl attach rs/nginx
 

-

-
 Update all containers in all replication controllers in the project to have ENV=prod

+
Attach to a process that is already running inside an existing container.

+
Usage

+
$ attach (POD | TYPE/NAME) -c CONTAINER

+
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameShorthandDefaultUsage
containercContainer name. If omitted, the first container in the pod will be chosen 
pod-running-timeout1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
stdinifalsePass stdin to the container 
ttytfalseStdin is a TTY 

+

+
auth

+
Inspect authorization

+
Usage

+
$ auth

+

+
can-i

+

+
 Check to see if I can create pods in any namespace

 

-
kubectl set env rc --all ENV=prod
+
kubectl auth can-i create pods --all-namespaces
 

 

-
 Import environment from a secret

+
 Check to see if I can list deployments in my current namespace

 

-
kubectl set env --from=secret/mysecret deployment/myapp
+
kubectl auth can-i list deployments.extensions
 

 

-
 Import environment from a config map with a prefix

+
 Check to see if I can do everything in my current namespace ("*" means all)

 

-
kubectl set env --from=configmap/myconfigmap --prefix=MYSQL_ deployment/myapp
+
kubectl auth can-i '*' '*'
 

 

-
 Remove the environment variable ENV from container 'c1' in all deployment configs

+
 Check to see if I can get the job named "bar" in namespace "foo"

 

-
kubectl set env deployments --all --containers="c1" ENV-
+
kubectl auth can-i list jobs.batch/bar -n foo
 

 

-
 Remove the environment variable ENV from a deployment definition on disk and # update the deployment config on the server

+
 Check to see if I can read pod logs

 

-
kubectl set env -f deploy.json ENV-
+
kubectl auth can-i get pods --subresource=log
 

 

-
 Set some of the local shell environment into a deployment config on the server

+
 Check to see if I can access the URL /logs/

 

-
env | grep RAILS_ | kubectl set env -e - deployment/registry
+
kubectl auth can-i get /logs/
 

-
Update environment variables on a pod template. 

-
List environment variable definitions in one or more pods, pod templates. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations). View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. 

-
If "--env -" is passed, environment variables can be read from STDIN using the standard env syntax. 

-
Possible resources include (case insensitive): 

-
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)

+
Check whether an action is allowed. 

+
VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL starts with "/". NAME is the name of a particular Kubernetes resource.

 
Usage

-
$ env RESOURCE/NAME KEY_1=VAL_1 ... KEY_N=VAL_N

+
$ can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL]

 
Flags

 
@@ -5161,64 +4802,58 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
+
+

 
 
 
 
allall-namespaces
 
 falseIf true, select all resources in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
containersc*The names of containers in the selected pod templates to change - may use wildcards If true, check the specified action in all namespaces. 
 

 
dry-runquietq
 falseIf true, only print the object that would be sent, without sending it. 
enve[]Specify a key-value pair for an environment variable to set into each container. 
filenamef[]Filename, directory, or URL to files the resource to update the env If true, suppress output and just return the exit code. 
 

 
fromsubresource
 
 The name of a resource from which to inject environment variables SubResource such as pod/log or deployment/scale 
 

+

+
reconcile

+

+
 Reconcile rbac resources from a file

+

+
kubectl auth reconcile -f my-rbac-rules.yaml
+

+
Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRole binding objects. 

+
This is preferred to 'apply' for RBAC resources so that proper rule coverage checks are done.

+
Usage

+
$ reconcile -f FILENAME

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -5227,94 +4862,38 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

 
listfalseIf true, display the environment and any changes in the standard format. this flag will removed when we have kubectl view env. NameShorthandDefaultUsage
 

 
localdry-run
 
 falseIf true, set env will NOT contact api-server but run locally. If true, display results but do not submit changes 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). filenamef[]Filename, directory, or URL to files identifying the resource to reconcile. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
overwritetrueIf true, allow environment to be overwritten, otherwise reject updates that overwrite existing environment. 
prefixPrefix to append to variable names 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 
resolvefalseIf true, show secret or configmap references when listing variables 
selectorlSelector (label query) to filter on 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 

 
 

 

-
image

+
cp

 

-
 Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'.

+
 !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image.  If 'tar' is not present, 'kubectl cp' will fail. # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace

 

-
kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
+
kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
 

 

-
 Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'

+
 Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container

 

-
kubectl set image deployments,rc nginx=nginx:1.9.1 --all
+
kubectl cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container>
 

 

-
 Update image of all containers of daemonset abc to 'nginx:1.9.1'

+
 Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace 

 

-
kubectl set image daemonset abc *=nginx:1.9.1
+
kubectl cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar
 

 

-
 Print result (in yaml format) of updating nginx container image from local file, without hitting the server

+
 Copy /tmp/foo from a remote pod to /tmp/bar locally

 

-
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
+
kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
 

-
Update existing container image(s) of resources. 

-
Possible resources include (case insensitive): 

-
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), replicaset (rs)

+
Copy files and directories to and from containers.

 
Usage

-
$ image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N

+
$ cp <file-spec-src> <file-spec-dest>

 
Flags

 
@@ -5327,64 +4906,80 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runcontainerc
 falseIf true, only print the object that would be sent, without sending it. 
filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Container name. If omitted, the first container in the pod will be chosen 
 

+

+
describe

+

+
 Describe a node

+

+
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
+

+

+
 Describe a pod

+

+
kubectl describe pods/nginx
+

+

+
 Describe a pod identified by type and name in "pod.json"

+

+
kubectl describe -f pod.json
+

+

+
 Describe all pods

+

+
kubectl describe pods
+

+

+
 Describe pods by label name=myLabel

+

+
kubectl describe po -l name=myLabel
+

+

+
 Describe all pods managed by the 'frontend' replication controller (rc-created pods # get the name of the rc as a prefix in the pod the name).

+

+
kubectl describe pods frontend
+

+
Show details of a specific resource or group of resources 

+
Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example: 

+
  $ kubectl describe TYPE NAME_PREFIX

+
will first check for an exact match on TYPE and NAME PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME PREFIX.

+
Use "kubectl api-resources" for a complete list of supported resources.

+
Usage

+
$ describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
+
-
+
@@ -5396,61 +4991,128 @@ 
Flags

-
+
-
-
+
+
-
+
+
+

 
localfalseIf true, set image will NOT contact api-server but run locally. NameShorthandDefaultUsage
 

 
no-headersall-namespaces
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). filenamef[]Filename, directory, or URL to files containing the resource to describe 
 

 
recordinclude-uninitialized
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 

 recursive
 selector
 l
 Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
show-allashow-events
 trueWhen printing, show all resources (default show all pods including terminated one.) If true, display events related to the described object. 
 

+

+
exec

+

+
 Get output from running 'date' from pod 123456-7890, using the first container by default

+

+
kubectl exec 123456-7890 date
+

+

+
 Get output from running 'date' in ruby-container from pod 123456-7890

+

+
kubectl exec 123456-7890 -c ruby-container date
+

+

+
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

+

+
kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
+

+

+
 List contents of /usr from the first container of pod 123456-7890 and sort by modification time. # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments. # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr").

+

+
kubectl exec 123456-7890 -i -t -- ls -t /usr
+

+
Execute a command in a container.

+
Usage

+
$ exec POD [-c CONTAINER] -- COMMAND [args...]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+

 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) NameShorthandDefaultUsage
 

 
sort-bycontainerc
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Container name. If omitted, the first container in the pod will be chosen 
 

 
templatepodp
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Pod name 
stdinifalsePass stdin to the container 
ttytfalseStdin is a TTY 
 

 
 

 

-
resources

+
logs

 

-
 Set a deployments nginx container cpu limits to "200m" and memory to "512Mi"

+
 Return snapshot logs from pod nginx with only one container

 

-
kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
+
kubectl logs nginx
 

 

-
 Set the resource request and limits for all containers in nginx

+
 Return snapshot logs from pod nginx with multi containers

 

-
kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
+
kubectl logs nginx --all-containers=true
 

 

-
 Remove the resource requests for resources on containers in nginx

+
 Return snapshot logs from all containers in pods defined by label app=nginx

 

-
kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0
+
kubectl logs -lapp=nginx --all-containers=true
 

 

-
 Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server

+
 Return snapshot of previous terminated ruby container logs from pod web-1

 

-
kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
+
kubectl logs -p -c ruby web-1
 

-
Specify compute resource requirements (cpu, memory) for any resource that defines a pod template.  If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits. 

-
for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit. 

-
Possible resources include (case insensitive): replicationcontroller, deployment, daemonset, job, replicaset.

+

+
 Begin streaming the logs of the ruby container in pod web-1

+

+
kubectl logs -f -c ruby web-1
+

+

+
 Display only the most recent 20 lines of output in pod nginx

+

+
kubectl logs --tail=20 nginx
+

+

+
 Show all logs from pod nginx written in the last hour

+

+
kubectl logs --since=1h nginx
+

+

+
 Return snapshot logs from first container of a job named hello

+

+
kubectl logs job/hello
+

+

+
 Return snapshot logs from container nginx-1 of a deployment named nginx

+

+
kubectl logs deployment/nginx -c nginx-1
+

+
Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.

 
Usage

-
$ resources (-f FILENAME | TYPE NAME)  ([--limits=LIMITS & --requests=REQUESTS]

+
$ logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER]

 
Flags

 
@@ -5463,133 +5125,160 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
+
-
+
-
-
+
-
+
+
-
+
+
+
+
+
+
+
-
+
-
+
+
-
-
+
-
-
+
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
+
-
+
-
+
+
+

 
 
 
 
allall-containers
 
 falseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. Get all containers's logs in the pod(s). 
 

 
containerscontainer
 c*The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards 
dry-run
 falseIf true, only print the object that would be sent, without sending it. Print the logs of this container 
 

 
filenamefollow
 f[]Filename, directory, or URL to files identifying the resource to get from a server. falseSpecify if the logs should be streamed. 
 

 
include-uninitializedinteractive
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. If true, prompt the user for input when required. 
 

 
limitslimit-bytes
 The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 0Maximum bytes of logs to return. Defaults to no limit. 
 

 
localpod-running-timeout
 20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
previousp
 falseIf true, set resources will NOT contact api-server but run locally. If true, print the logs for the previous instance of the container in a pod if it exists. 
 

 
no-headersselectorl
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Selector (label query) to filter on. 
 

 
outputosince
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 0sOnly return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. 
 

 
output-versionsince-time
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. 
 

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
requestsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
selectorltail
 Selector (label query) to filter on, not including uninitialized ones,supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) -1Lines of recent log file to display. Defaults to -1 with no selector, showing all log lines otherwise 10, if a selector is provided. 
 

 
show-labelstimestamps
 
 falseWhen printing, show all labels as the last column (default hide labels column) Include timestamps on each line in the log output 
 

+

+
port-forward

+

+
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod

+

+
kubectl port-forward pod/mypod 5000 6000
+

+

+
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment

+

+
kubectl port-forward deployment/mydeployment 5000 6000
+

+

+
 Listen on port 8888 locally, forwarding to 5000 in the pod

+

+
kubectl port-forward pod/mypod 8888:5000
+

+

+
 Listen on a random port locally, forwarding to 5000 in the pod

+

+
kubectl port-forward pod/mypod :5000
+

+
Forward one or more local ports to a pod. 

+
Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted. 

+
If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and rerun of the command is needed to resume forwarding.

+
Usage

+
$ port-forward TYPE/NAME [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
-
+
+

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. NameShorthandDefaultUsage
 

 
templatepod-running-timeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

 
 

 

-
selector

+
proxy

 

-
 set the labels and selector before creating a deployment/service pair.

+
 To proxy all of the kubernetes api and nothing else, use:

 

-
kubectl create service clusterip my-svc --clusterip="None" -o yaml --dry-run | kubectl set selector --local -f - 'environment=qa' -o yaml | kubectl create -f -
-kubectl create deployment my-dep -o yaml --dry-run | kubectl label --local -f - environment=qa -o yaml | kubectl create -f -
+
$ kubectl proxy --api-prefix=/
 

-
Set the selector on a resource. Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of 'set selector'. 

-
A selector must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. Note: currently selectors can only be set on Service objects.

+

+
 To proxy only part of the kubernetes api and also some static files:

+

+
$ kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
+

+

+
 The above lets you 'curl localhost:8001/api/v1/pods'. # To proxy the entire kubernetes api at a different root, use:

+

+
$ kubectl proxy --api-prefix=/custom/
+

+

+
 The above lets you 'curl localhost:8001/custom/api/v1/pods' # Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/

+

+
kubectl proxy --port=8011 --www=./local/www/
+

+

+
 Run a proxy to kubernetes apiserver on an arbitrary local port. # The chosen port for the server will be output to stdout.

+

+
kubectl proxy --port=0
+

+

+
 Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api # This makes e.g. the pods api available at localhost:8001/k8s-api/v1/pods/

+

+
kubectl proxy --api-prefix=/k8s-api
+

+
Creates a proxy server or application-level gateway between localhost and the Kubernetes API Server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote kubernetes API Server port, except for the path matching the static content path.

 
Usage

-
$ selector (-f FILENAME | TYPE NAME) EXPRESSIONS [--resource-version=version]

+
$ proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]

 
Flags

 
@@ -5602,120 +5291,96 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
+
-
-
-
-
-
-
-
-
+
+
-
-
+
-
-
-
-
-
-
-
+
+
-
+
+
-
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keysaccept-hosts
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. ^localhost$,^127.0.0.1$,^[::1]$Regular expression for hosts that the proxy should accept. 
 

 
dry-runaccept-paths
 falseIf true, only print the object that would be sent, without sending it. 
filenamef[]Filename, directory, or URL to files the resource to update the selectors ^.*Regular expression for paths that the proxy should accept. 
 

 
include-uninitializedaddress
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 127.0.0.1The IP address on which to serve on. 
 

 
localapi-prefix
 falseIf true, set selector will NOT contact api-server but run locally. /Prefix to serve the proxied API under. 
 

 
no-headersdisable-filter
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). portp8001The port on which to run the proxy. Set to 0 to pick a random port. 
 

 
recordreject-methods
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. ^$Regular expression for HTTP methods that the proxy should reject (example --reject-methods='POST,PUT,PATCH').  
 

 
resource-versionreject-paths
 If non-empty, the selectors update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) ^/api/./pods/./exec,^/api/./pods/./attachRegular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by --accept-paths. 
 

 
show-labelsunix-socketu
 falseWhen printing, show all labels as the last column (default hide labels column) Unix socket on which to run the proxy. 
 

 
sort-bywwww
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Also serve static files from the given directory under the specified prefix. 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. www-prefixP/static/Prefix to serve static files under, if static file directory is specified. 
 

 
 

 

-
serviceaccount

+
top

+
Display Resource (CPU/Memory/Storage) usage. 

+
The top command allows you to see the resource consumption for nodes or pods. 

+
This command requires Heapster to be correctly configured and working on the server.

+
Usage

+
$ top

+

+
node

 

-
 Set Deployment nginx-deployment's ServiceAccount to serviceaccount1

+
 Show metrics for all nodes

 

-
kubectl set serviceaccount deployment nginx-deployment serviceaccount1
+
kubectl top node
 

 

-
 Print the result (in yaml format) of updated nginx deployment with serviceaccount from local file, without hitting apiserver

+
 Show metrics for a given node

 

-
kubectl set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
+
kubectl top node NODE_NAME
 

-
Update ServiceAccount of pod template resources. 

-
Possible resources (case insensitive) can be: 

-
replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset

+
Display Resource (CPU/Memory/Storage) usage of nodes. 

+
The top-node command allows you to see the resource consumption of nodes.

 
Usage

-
$ serviceaccount (-f FILENAME | TYPE NAME) SERVICE_ACCOUNT

+
$ node [NAME | -l label]

 
Flags

 
@@ -5728,117 +5393,142 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
+
-
-
+
+
+

 
 
 
 
allheapster-namespace
 falseSelect all resources, including uninitialized ones, in the namespace of the specified resource types kube-systemNamespace Heapster service is located in 
 

 
allow-missing-template-keysheapster-port
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. Port name in service to use 
 

 
dry-runheapster-scheme
 falseIf true, only print the object that would be sent, without sending it. httpScheme (http or https) to connect to Heapster as 
 

 
filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. heapster-serviceheapsterName of Heapster service 
 

 
include-uninitializedselectorl
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

+

+
pod

+

+
 Show metrics for all pods in the default namespace

+

+
kubectl top pod
+

+

+
 Show metrics for all pods in the given namespace

+

+
kubectl top pod --namespace=NAMESPACE
+

+

+
 Show metrics for a given pod and its containers

+

+
kubectl top pod POD_NAME --containers
+

+

+
 Show metrics for the pods defined by label name=myLabel

+

+
kubectl top pod -l name=myLabel
+

+
Display Resource (CPU/Memory/Storage) usage of pods. 

+
The 'top pod' command allows you to see the resource consumption of pods. 

+
Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.

+
Usage

+
$ pod [NAME | -l label]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
+
+
-
+

 
localfalseIf true, set serviceaccount will NOT contact api-server but run locally. NameShorthandDefaultUsage
 

 
no-headersall-namespaces
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
 

 
outputocontainers
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseIf present, print usage of containers within a pod. 
 

 
output-versionheapster-namespace
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). kube-systemNamespace Heapster service is located in 
 

 
recordheapster-port
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Port name in service to use 
 

 
show-labelsheapster-scheme
 falseWhen printing, show all labels as the last column (default hide labels column) httpScheme (http or https) to connect to Heapster as 
 

 
sort-byheapster-service
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. heapsterName of Heapster service 
 

 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
 

+
CLUSTER MANAGEMENT

 

-
subject

-

-
 Update a ClusterRoleBinding for serviceaccount1

-

-
kubectl set subject clusterrolebinding admin --serviceaccount=namespace:serviceaccount1
-

-

-
 Update a RoleBinding for user1, user2, and group1

-

-
kubectl set subject rolebinding admin --user=user1 --user=user2 --group=group1
-

+
api-versions

 

-
 Print the result (in yaml format) of updating rolebinding subjects from a local, without hitting the server

+
 Print the supported API versions

 

-
kubectl create rolebinding admin --role=admin --user=admin -o yaml --dry-run | kubectl set subject --local -f - --user=foo -o yaml
+
kubectl api-versions
 

-
Update User, Group or ServiceAccount in a RoleBinding/ClusterRoleBinding.

+
Print the supported API versions on the server, in the form of "group/version"

 
Usage

-
$ subject (-f FILENAME | TYPE NAME) [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
$ api-versions

+

+
certificate

+
Modify certificate resources.

+
Usage

+
$ certificate SUBCOMMAND

+

+
approve

+
Approve a certificate signing request. 

+
kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR. 

+
SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.

+
Usage

+
$ approve (-f FILENAME | NAME)

 
Flags

 
@@ -5851,52 +5541,16 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
@@ -5905,83 +5559,92 @@ 
Flags

-
-
-
-
-
-
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files the resource to update the subjects 
group[]Groups to bind to the role 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
localfalseIf true, set subject will NOT contact api-server but run locally. Filename, directory, or URL to files identifying the resource to update 
 

 
no-headersforce
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Update the CSR even if it is already approved. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

+

+
deny

+
Deny a certificate signing request. 

+
kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.

+
Usage

+
$ deny (-f FILENAME | NAME)

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+

 
selectorlSelector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) NameShorthandDefaultUsage
 

 
serviceaccountfilenamef
 []Service accounts to bind to the role 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Filename, directory, or URL to files identifying the resource to update 
 

 
show-labelsforce
 
 falseWhen printing, show all labels as the last column (default hide labels column) Update the CSR even if it is already denied. 
 

 
sort-byoutputo
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
 

-
DECLARATIVE APP MANAGEMENT

 

-
apply

+
cluster-info

 

-
 Apply the configuration in pod.json to a pod.

+
 Print the address of the master and cluster services

 

-
kubectl apply -f ./pod.json
+
kubectl cluster-info
 

+
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

+
Usage

+
$ cluster-info

+

+
dump

 

-
 Apply the JSON passed into stdin to a pod.

+
 Dump current cluster state to stdout

 

-
cat pod.json | kubectl apply -f -
+
kubectl cluster-info dump
 

 

-
 Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.

+
 Dump current cluster state to /path/to/cluster-state

 

-
kubectl apply --prune -f manifest.yaml -l app=nginx
+
kubectl cluster-info dump --output-directory=/path/to/cluster-state
 

 

-
 Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.

+
 Dump all namespaces to stdout

 

-
kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
+
kubectl cluster-info dump --all-namespaces
 

-
Apply a configuration to a resource by filename or stdin. The resource name must be specified. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. 

-
JSON and YAML formats are accepted. 

-
Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.

+

+
 Dump a set of namespaces to /path/to/cluster-state

+

+
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
+

+
Dumps cluster info out suitable for debugging and diagnosing cluster problems.  By default, dumps everything to stdout. You can optionally specify a directory with --output-directory.  If you specify a directory, kubernetes will build a set of files in that directory.  By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. 

+
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name.

 
Usage

-
$ apply -f FILENAME

+
$ dump

 
Flags

 
@@ -5994,176 +5657,179 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
+
+

 
 
 
 
allall-namespaces
 
 falseSelect all resources in the namespace of the specified resource types. 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
cascadetrueOnly relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). If true, dump all namespaces.  If true, --namespaces is ignored. 
 

 
dry-runnamespaces
 falseIf true, only print the object that would be sent, without sending it. 
filenamef
 []Filename, directory, or URL to files that contains the configuration to apply A comma separated list of namespaces to dump. 
 

 
forceoutput-directory
 falseDelete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. 
grace-period
 -1Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. Where to output the files.  If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory 
 

 
include-extended-apispod-running-timeout
 trueIf true, include definitions of new APIs via calls to the API server. [default true] 20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

+

+
cordon

+

+
 Mark node "foo" as unschedulable.

+

+
kubectl cordon foo
+

+
Mark node as unschedulable.

+
Usage

+
$ cordon NODE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
+
+

 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. NameShorthandDefaultUsage
 

 
no-headersdry-run
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
openapi-patchtrueIf true, use openapi to calculate diff when the openapi presents and the resource can be found in the openapi spec. Otherwise, fall back to use baked-in types. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. If true, only print the object that would be sent, without sending it. 
 

 
output-versionselectorl
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). Selector (label query) to filter on 
 

+

+
drain

+

+
 Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.

+

+
$ kubectl drain foo --force
+

+

+
 As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.

+

+
$ kubectl drain foo --grace-period=900
+

+
Drain node in preparation for maintenance. 

+
The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the APIServer supports eviction (http://kubernetes.io/docs/admin/disruptions/). Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server).  If there are DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings.  If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet or Job, then drain will not delete any pods unless you use --force.  --force will also allow deletion to proceed if the managing resource of one or more pods is missing. 

+
'drain' waits for graceful termination. You should not operate on the machine until the command completes. 

+
When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. 

+
! http://kubernetes.io/images/docs/kubectl_drain.svg

+
Usage

+
$ drain NODE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
-
-
+
-
-
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
-
-
-
+

 
overwritetrueAutomatically resolve conflicts between the modified and live configuration by using values from the modified configuration NameShorthandDefaultUsage
 

 
prunedelete-local-data
 
 falseAutomatically delete resource objects, including the uninitialized ones, that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all. 
prune-whitelist[]Overwrite the default whitelist with  for --prune Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). 
 

 
recorddry-run
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, only print the object that would be sent, without sending it. 
 

 
recursiveRforce
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet. 
 

 
selectorlgrace-period
 Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) -1Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. 
 

 
show-labelsignore-daemonsets
 
 falseWhen printing, show all labels as the last column (default hide labels column) Ignore DaemonSet-managed pods. 
 

 
sort-bypod-selector
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Label selector to filter pods on the node 
 

 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on 
 

 

 timeout
 
 0sOnly relevant during a force apply. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). 
validatetrueIf true, use a schema to validate the input before sending it The length of time to wait before giving up, zero means infinite 
 

 
 

 

-
edit-last-applied

+
taint

 

-
 Edit the last-applied-configuration annotations by type/name in YAML.

+
 Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. # If a taint with that key and effect already exists, its value is replaced as specified.

 

-
kubectl apply edit-last-applied deployment/nginx
+
kubectl taint nodes foo dedicated=special-user:NoSchedule
 

 

-
 Edit the last-applied-configuration annotations by file in JSON.

+
 Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists.

 

-
kubectl apply edit-last-applied -f deploy.yaml -o json
+
kubectl taint nodes foo dedicated:NoSchedule-
 

-
Edit the latest last-applied-configuration annotations of resources from the default editor. 

-
The edit-last-applied command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

-
The default format is YAML. To edit in JSON, specify "-o json". 

-
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

-
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

+

+
 Remove from node 'foo' all the taints with key 'dedicated'

+

+
kubectl taint nodes foo dedicated-
+

+

+
 Add a taint with key 'dedicated' on nodes having label mylabel=X

+

+
kubectl taint node -l myLabel=X  dedicated=foo:PreferNoSchedule
+

+
Update the taints on one or more nodes. 

+
    
+
  • A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.  
    • 
+
  • The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  253 characters.  
    • 
+
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
+
  • The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters.  
    • 
+
  • The effect must be NoSchedule, PreferNoSchedule or NoExecute.  
    • 
+
  • Currently taint can only apply to node.
    • 
+

 
Usage

-
$ edit-last-applied (RESOURCE/NAME | -f FILENAME)

+
$ taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N

 
Flags

 
@@ -6176,63 +5842,47 @@ 
Flags

-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+

 
 
 
 
filenamef[]Filename, directory, or URL to files to use to edit the resource 
include-uninitializedall
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Select all nodes in the cluster 
 

 

 output
 oyamlOutput format. One of: yaml|json. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
recordoverwrite
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. 
 

 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
windows-line-endingsvalidate
 falseDefaults to the line ending native to your platform. trueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
set-last-applied

+
uncordon

 

-
 Set the last-applied-configuration of a resource to match the contents of a file.

+
 Mark node "foo" as schedulable.

 

-
kubectl apply set-last-applied -f deploy.yaml
-

-

-
 Execute set-last-applied against each configuration file in a directory.

-

-
kubectl apply set-last-applied -f path/
-

-

-
 Set the last-applied-configuration of a resource to match the contents of a file, will create the annotation if it does not already exist.

-

-
kubectl apply set-last-applied -f deploy.yaml --create-annotation=true
+
$ kubectl uncordon foo
 

-
Set the latest last-applied-configuration annotations by setting it to match the contents of a file. This results in the last-applied-configuration being updated as though 'kubectl apply -f ' was run, without updating any other parts of the object.

+
Mark node as schedulable.

 
Usage

-
$ set-last-applied -f FILENAME

+
$ uncordon NODE

 
Flags

 
@@ -6245,95 +5895,48 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
create-annotationfalseWill create 'last-applied-configuration' annotations if current objects doesn't have one 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
filenamef[]Filename, directory, or URL to files that contains the last-applied-configuration annotations 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on 
 

 
 

+
KUBECTL SETTINGS AND USAGE

 

-
view-last-applied

+
alpha

+
These commands correspond to alpha features that are not enabled in Kubernetes clusters by default.

+
Usage

+
$ alpha

+

+
diff

 

-
 View the last-applied-configuration annotations by type/name in YAML.

+
 Diff resources included in pod.json. By default, it will diff LOCAL and LIVE versions

 

-
kubectl apply view-last-applied deployment/nginx
+
kubectl alpha diff -f pod.json
 

 

-
 View the last-applied-configuration annotations by file in JSON

+
 When one version is specified, diff that version against LIVE

 

-
kubectl apply view-last-applied -f deploy.yaml -o json
+
cat service.yaml | kubectl alpha diff -f - MERGED
 

-
View the latest last-applied-configuration annotations by type/name or file. 

-
The default output will be printed to stdout in YAML format. One can use -o option to change output format.

+

+
 Or specify both versions

+

+
kubectl alpha diff -f pod.json -f service.yaml LAST LOCAL
+

+
Diff configurations specified by filename or stdin between their local, last-applied, live and/or "merged" versions. 

+
LOCAL and LIVE versions are diffed by default. Other available keywords are MERGED and LAST. 

+
Output is always YAML. 

+
KUBERNETES EXTERNAL DIFF environment variable can be used to select your own diff command. By default, the "diff" command available in your path will be run with "-u" (unicode) and "-N" (treat new files as empty) options.

 
Usage

-
$ view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FILENAME)

+
$ diff -f FILENAME

 
Flags

 
@@ -6346,22 +5949,10 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -6369,47 +5960,38 @@ 
Flags

-
-
-
-
-
-

 
 
 
 
allfalseSelect all resources in the namespace of the specified resource types 

 filename
 f
 []Filename, directory, or URL to files that contains the last-applied-configuration annotations 
outputoOutput format. Must be one of yaml|json Filename, directory, or URL to files contains the configuration to diff 
 

 

 recursive
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

 
 

-
WORKING WITH APPS

-
This section contains commands for inspecting and debugging your
-applications.

-
    
-
  • logs will print the logs from the specified pod + container.
    • 
-
  • exec can be used to get an interactive shell on a pod + container.
    • 
-
  • describe will print debug information about the given resource.
    • 
-

 

-
attach

+
api-resources

 

-
 Get output from running pod 123456-7890, using the first container by default

+
 Print the supported API Resources

 

-
kubectl attach 123456-7890
+
kubectl api-resources
 

 

-
 Get output from ruby-container from pod 123456-7890

+
 Print the supported API Resources with more information

 

-
kubectl attach 123456-7890 -c ruby-container
+
kubectl api-resources -o wide
 

 

-
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

+
 Print the supported namespaced resources

 

-
kubectl attach 123456-7890 -c ruby-container -i -t
+
kubectl api-resources --namespaced=true
 

 

-
 Get output from the first pod of a ReplicaSet named nginx

+
 Print the supported non-namespaced resources

 

-
kubectl attach rs/nginx
+
kubectl api-resources --namespaced=false
 

-
Attach to a process that is already running inside an existing container.

+

+
 Print the supported API Resources with specific APIGroup

+

+
kubectl api-resources --api-group=extensions
+

+
Print the supported API resources on the server

 
Usage

-
$ attach (POD | TYPE/NAME) -c CONTAINER

+
$ api-resources

 
Flags

 
@@ -6422,77 +6004,164 @@ 
Flags

-
-
+
-
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
containercapi-group
 Container name. If omitted, the first container in the pod will be chosen Limit to resources in the specified API group. 
 

 
pod-running-timeoutcached
 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running falseUse the cached list of resources if available. 
 

 
stdinifalsePass stdin to the container namespacedtrueIf false, non-namespaced resources will be returned, otherwise returning namespaced resources by default. 
 

 
ttytno-headers
 falseStdin is a TTY When using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: wide|name. 
verbs[]Limit to resources that support the specified verbs. 
 

 
 

 

-
auth

-
Inspect authorization

-
Usage

-
$ auth

-

-
can-i

+
completion

 

-
 Check to see if I can create pods in any namespace

+
 Installing bash completion on macOS using homebrew ## If running Bash 3.2 included with macOS

 

-
kubectl auth can-i create pods --all-namespaces
+
brew install bash-completion
+

+

+
 or, if running Bash 4.1+

+

+
brew install bash-completion@2
+

+

+
 If kubectl is installed via homebrew, this should start working immediately. ## If you've installed via other means, you may need add the completion to your completion directory

+

+
kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl
 

 

-
 Check to see if I can list deployments in my current namespace

+
 Installing bash completion on Linux ## Load the kubectl completion code for bash into the current shell

 

-
kubectl auth can-i list deployments.extensions
+
source <(kubectl completion bash)
+

+

+
 Write bash completion code to a file and source if from .bash_profile

+

+
kubectl completion bash > ~/.kube/completion.bash.inc
+printf "
 

 

-
 Check to see if I can do everything in my current namespace ("*" means all)

+
 Kubectl shell completion

 

-
kubectl auth can-i '*' '*'
+
source '$HOME/.kube/completion.bash.inc'
+" >> $HOME/.bash_profile
+source $HOME/.bash_profile
 

 

-
 Check to see if I can get the job named "bar" in namespace "foo"

+
 Load the kubectl completion code for zsh[1] into the current shell

 

-
kubectl auth can-i list jobs.batch/bar -n foo
+
source <(kubectl completion zsh)
 

 

-
 Check to see if I can read pod logs

+
 Set the kubectl completion code for zsh[1] to autoload on startup

 

-
kubectl auth can-i get pods --subresource=log
+
kubectl completion zsh > "${fpath[1]}/_kubectl"
 

+
Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubectl commands.  This can be done by sourcing it from the .bash _profile. 

+
Detailed instructions on how to do this are available here: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion 

+
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2

+
Usage

+
$ completion SHELL

+

+
config

+
Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" 

+
The loading order follows these rules: 

+
    
+
  1. If the --kubeconfig flag is set, then only that file is loaded.  The flag may only be set once and no merging takes place.  
    2. 
+
  2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system).  These paths are merged.  When a value is modified, it is modified in the file that defines the stanza.  When a value is created, it is created in the first file that exists.  If no files in the chain exist, then it creates the last file in the list.  
    3. 
+
  3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
    4. 
+

+
Usage

+
$ config SUBCOMMAND

+

+
current-context

 

-
 Check to see if I can access the URL /logs/

+
 Display the current-context

 

-
kubectl auth can-i get /logs/
+
kubectl config current-context
 

-
Check whether an action is allowed. 

-
VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL starts with "/". NAME is the name of a particular Kubernetes resource.

+
Displays the current-context

 
Usage

-
$ can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL]

-
Flags

-
-
-
-
+
$ current-context

+

+
delete-cluster

+

+
 Delete the minikube cluster

+

+
kubectl config delete-cluster minikube
+

+
Delete the specified cluster from the kubeconfig

+
Usage

+
$ delete-cluster NAME

+

+
delete-context

+

+
 Delete the context for the minikube cluster

+

+
kubectl config delete-context minikube
+

+
Delete the specified context from the kubeconfig

+
Usage

+
$ delete-context NAME

+

+
get-clusters

+

+
 List the clusters kubectl knows about

+

+
kubectl config get-clusters
+

+
Display clusters defined in the kubeconfig.

+
Usage

+
$ get-clusters

+

+
get-contexts

+

+
 List all the contexts in your kubeconfig file

+

+
kubectl config get-contexts
+

+

+
 Describe one context in your kubeconfig file.

+

+
kubectl config get-contexts my-context
+

+
Displays one or many contexts from the kubeconfig file.

+
Usage

+
$ get-contexts [(-o|--output=)name)]

+
Flags

+
Name

+
+
+
@@ -6500,36 +6169,39 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
-
+
+
-
+
Name
 Shorthand
 Default
 Usage
 

 
 
all-namespacesno-headers
 
 falseIf true, check the specified action in all namespaces. 
quietqfalseIf true, suppress output and just return the exit code. When using the default or custom-column output format, don't print headers (default print headers). 
 

 
subresourceoutputo
 SubResource such as pod/log or deployment/scale Output format. One of: name 
 

 
 

 

-
reconcile

+
rename-context

 

-
 Reconcile rbac resources from a file

+
 Rename the context 'old-name' to 'new-name' in your kubeconfig file

 

-
kubectl auth reconcile -f my-rbac-rules.yaml
+
kubectl config rename-context old-name new-name
 

-
Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRole binding objects. 

-
This is preferred to 'apply' for RBAC resources so that proper rule coverage checks are done.

+
Renames a context from the kubeconfig file. 

+
CONTEXT _NAME is the context name that you wish change. 

+
NEW _NAME is the new name you wish to set. 

+
Note: In case the context being renamed is the 'current-context', this field will also be updated.

 
Usage

-
$ reconcile -f FILENAME

+
$ rename-context CONTEXT_NAME NEW_NAME

+

+
set

+
Sets an individual value in a kubeconfig file 

+
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots. 

+
PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.

+
Usage

+
$ set PROPERTY_NAME PROPERTY_VALUE

 
Flags

 
@@ -6542,92 +6214,34 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
filenamef[]Filename, directory, or URL to files identifying the resource to reconcile. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsset-raw-bytes
 
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding. 
 

 
 

 

-
cp

-

-
 !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image.  If 'tar' is not present, 'kubectl cp' will fail. # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace

-

-
kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
-

+
set-cluster

 

-
 Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container

+
 Set only the server field on the e2e cluster entry without touching other values.

 

-
kubectl cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container>
+
kubectl config set-cluster e2e --server=https://1.2.3.4
 

 

-
 Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace 

+
 Embed certificate authority data for the e2e cluster entry

 

-
kubectl cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar
+
kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
 

 

-
 Copy /tmp/foo from a remote pod to /tmp/bar locally

+
 Disable cert checking for the dev cluster entry

 

-
kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
+
kubectl config set-cluster e2e --insecure-skip-tls-verify=true
 

-
Copy files and directories to and from containers.

+
Sets a cluster entry in kubeconfig. 

+
Specifying a name that already exists will merge new fields on top of existing values for those fields.

 
Usage

-
$ cp <file-spec-src> <file-spec-dest>

+
$ set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true]

 
Flags

 
@@ -6640,91 +6254,67 @@ 
Flags

-
-
+
-
+
+

 
 
 
 
containercembed-certs
 Container name. If omitted, the first container in the pod will be chosen falseembed-certs for the cluster entry in kubeconfig 
 

 
 

 

-
describe

+
set-context

 

-
 Describe a node

+
 Set the user field on the gce context entry without touching other values

 

-
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
+
kubectl config set-context gce --user=cluster-admin
 

+
Sets a context entry in kubeconfig 

+
Specifying a name that already exists will merge new fields on top of existing values for those fields.

+
Usage

+
$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]

+

+
set-credentials

 

-
 Describe a pod

+
 Set only the "client-key" field on the "cluster-admin" # entry, without touching other values:

 

-
kubectl describe pods/nginx
+
kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
 

 

-
 Describe a pod identified by type and name in "pod.json"

+
 Set basic auth for the "cluster-admin" entry

 

-
kubectl describe -f pod.json
+
kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
 

 

-
 Describe all pods

+
 Embed client certificate data in the "cluster-admin" entry

 

-
kubectl describe pods
+
kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
 

 

-
 Describe pods by label name=myLabel

+
 Enable the Google Compute Platform auth provider for the "cluster-admin" entry

 

-
kubectl describe po -l name=myLabel
+
kubectl config set-credentials cluster-admin --auth-provider=gcp
 

 

-
 Describe all pods managed by the 'frontend' replication controller (rc-created pods # get the name of the rc as a prefix in the pod the name).

+
 Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args

 

-
kubectl describe pods frontend
+
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
 

-
Show details of a specific resource or group of resources 

-
Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example: 

-
  $ kubectl describe TYPE NAME_PREFIX

-
will first check for an exact match on TYPE and NAME PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME PREFIX.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

+

+
 Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry

+

+
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
+

+
Sets a user entry in kubeconfig 

+
Specifying a name that already exists will merge new fields on top of existing values. 

+
  Client-certificate flags:
+  --client-certificate=certfile --client-key=keyfile

+
  Bearer token flags:
+    --token=bearer_token

+
  Basic auth flags:
+    --username=basic_user --password=basic_password

+
Bearer token and basic auth are mutually exclusive.

 
Usage

-
$ describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

+
$ set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]

 
Flags

 
@@ -6737,74 +6327,84 @@ 
Flags

-
+
-
-
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+

 
 
 
 
all-namespacesauth-provider
 falseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. Auth provider for the user entry in kubeconfig 
 

 
filenamefauth-provider-arg
 []Filename, directory, or URL to files containing the resource to describe 'key=value' arguments for the auth provider 
 

 
include-extended-apisembed-certs
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseEmbed client cert/key for the user entry in kubeconfig 
 

 
include-uninitializedpassword
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. password for the user entry in kubeconfig 
 

 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-eventstrueIf true, display events related to the described object. usernameusername for the user entry in kubeconfig 
 

 
 

 

-
exec

+
unset

 

-
 Get output from running 'date' from pod 123456-7890, using the first container by default

+
 Unset the current-context.

 

-
kubectl exec 123456-7890 date
+
kubectl config unset current-context
 

 

-
 Get output from running 'date' in ruby-container from pod 123456-7890

+
 Unset namespace in foo context.

 

-
kubectl exec 123456-7890 -c ruby-container date
+
kubectl config unset contexts.foo.namespace
 

+
Unsets an individual value in a kubeconfig file 

+
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots.

+
Usage

+
$ unset PROPERTY_NAME

+

+
use-context

 

-
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

+
 Use the context for the minikube cluster

 

-
kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
+
kubectl config use-context minikube
+

+
Sets the current-context in a kubeconfig file

+
Usage

+
$ use-context CONTEXT_NAME

+

+
view

+

+
 Show merged kubeconfig settings.

+

+
kubectl config view
 

 

-
 List contents of /usr from the first container of pod 123456-7890 and sort by modification time. # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments. # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr").

+
 Show merged kubeconfig settings and raw certificate data.

 

-
kubectl exec 123456-7890 -i -t -- ls -t /usr
+
kubectl config view --raw
 

-
Execute a command in a container.

+

+
 Get the password for the e2e user

+

+
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
+

+
Display merged kubeconfig settings or a specified kubeconfig file. 

+
You can use --output jsonpath={...} to extract specific values using a jsonpath expression.

 
Usage

-
$ exec POD [-c CONTAINER] -- COMMAND [args...]

+
$ view

 
Flags

 
@@ -6817,76 +6417,183 @@ 
Flags

-
-
+
-
+
+
-
-
+
-
+
+
-
-
+
+
+
+
+
+
+
+
-
+
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+

 
 
 
 
containercallow-missing-template-keys
 Container name. If omitted, the first container in the pod will be chosen trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
podpflatten
 Pod name falseFlatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files) 
 

 
stdinimergetrueMerge the full hierarchy of kubeconfig files 
minify
 falsePass stdin to the container Remove all information not used by current-context from the output 
 

 
ttytoutputoyamlOutput format. One of: json|yaml|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
raw
 falseStdin is a TTY Display raw byte data 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
 

 

-
logs

+
explain

 

-
 Return snapshot logs from pod nginx with only one container

+
 Get the documentation of the resource and its fields

 

-
kubectl logs nginx
+
kubectl explain pods
+

+

+
 Get the documentation of a specific field of a resource

+

+
kubectl explain pods.spec.containers
 

+
List the fields for supported resources 

+
This command describes the fields associated with each supported API resource. Fields are identified via a simple JSONPath identifier: 

+
  .[.]

+
Add the --recursive flag to display all of the fields at once without descriptions. Information about each field is retrieved from the server in OpenAPI format.

+
Use "kubectl api-resources" for a complete list of supported resources.

+
Usage

+
$ explain RESOURCE

+
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameShorthandDefaultUsage
api-versionGet different explanations for particular API version 
recursivefalsePrint the fields of fields (Currently only 1 level deep) 

+

+
options

 

-
 Return snapshot logs for the pods defined by label app=nginx

+
 Print flags inherited by all commands

 

-
kubectl logs -lapp=nginx
+
kubectl options
 

+
Print the list of flags inherited by all commands

+
Usage

+
$ options

+

+
plugin

+
Runs a command-line plugin. 

+
Plugins are subcommands that are not part of the major command-line distribution and can even be provided by third-parties. Please refer to the documentation and examples for more information about how to install and write your own plugins.

+
Usage

+
$ plugin NAME

+

+
version

 

-
 Return snapshot of previous terminated ruby container logs from pod web-1

+
 Print the client and server versions for the current context

 

-
kubectl logs -p -c ruby web-1
+
kubectl version
 

+
Print the client and server version information for the current context

+
Usage

+
$ version

+
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameShorthandDefaultUsage
clientcfalseClient version only (no server required). 
outputoOne of 'yaml' or 'json'. 
shortfalsePrint just the version number. 

+
DEPRECATED COMMANDS

+

+
rolling-update

 

-
 Begin streaming the logs of the ruby container in pod web-1

+
 Update pods of frontend-v1 using new replication controller data in frontend-v2.json.

 

-
kubectl logs -f -c ruby web-1
+
kubectl rolling-update frontend-v1 -f frontend-v2.json
 

 

-
 Display only the most recent 20 lines of output in pod nginx

+
 Update pods of frontend-v1 using JSON data passed into stdin.

 

-
kubectl logs --tail=20 nginx
+
cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
 

 

-
 Show all logs from pod nginx written in the last hour

+
 Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the # name of the replication controller.

 

-
kubectl logs --since=1h nginx
+
kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2
 

 

-
 Return snapshot logs from first container of a job named hello

+
 Update the pods of frontend by just changing the image, and keeping the old name.

 

-
kubectl logs job/hello
+
kubectl rolling-update frontend --image=image:v2
 

 

-
 Return snapshot logs from container nginx-1 of a deployment named nginx

+
 Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2).

 

-
kubectl logs deployment/nginx -c nginx-1
+
kubectl rolling-update frontend-v1 frontend-v2 --rollback
 

-
Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.

+
Perform a rolling update of the given ReplicationController. 

+
Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the new PodTemplate. The new-controller.json must specify the same namespace as the existing replication controller and overwrite at least one (common) label in its replicaSelector. 

+
! http://kubernetes.io/images/docs/kubectl_rollingupdate.svg

 
Usage

-
$ logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER]

+
$ rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)

 
Flags

 
@@ -6900,159 +6607,144 @@ 
Flags

-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+

 
 
 

 containerc
 Print the logs of this container 
followffalseSpecify if the logs should be streamed. Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod 
 

 
include-extended-apisdeployment-label-key
 trueIf true, include definitions of new APIs via calls to the API server. [default true] deploymentThe key to use to differentiate between two different controllers, default 'deployment'.  Only relevant when --image is specified, ignored otherwise 
 

 
interactivedry-run
 
 falseIf true, prompt the user for input when required. If true, only print the object that would be sent, without sending it. 
 

 
limit-bytesfilenamef[]Filename or URL to file to use to create the new replication controller. 
image
 0Maximum bytes of logs to return. Defaults to no limit. Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag).  Can not be used with --filename/-f 
 

 
pod-running-timeoutimage-pull-policy
 20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. 
 

 
previouspfalseIf true, print the logs for the previous instance of the container in a pod if it exists. outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
selectorlpoll-interval
 Selector (label query) to filter on. 3sTime delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
 

 
sincerollback
 0sOnly return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. falseIf true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout 
 

 
since-timetimeout
 Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. 5m0sMax time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
 

 
tailupdate-period
 -1Lines of recent log file to display. Defaults to -1 with no selector, showing all log lines otherwise 10, if a selector is provided. 1m0sTime to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
 

 
timestampsvalidate
 falseInclude timestamps on each line in the log output trueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
port-forward

+
run-container

 

-
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod

+
 Start a single instance of nginx.

 

-
kubectl port-forward pod/mypod 5000 6000
+
kubectl run nginx --image=nginx
 

 

-
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment

+
 Start a single instance of hazelcast and let the container expose port 5701 .

 

-
kubectl port-forward deployment/mydeployment 5000 6000
+
kubectl run hazelcast --image=hazelcast --port=5701
 

 

-
 Listen on port 8888 locally, forwarding to 5000 in the pod

+
 Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

 

-
kubectl port-forward pod/mypod 8888:5000
+
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
 

 

-
 Listen on a random port locally, forwarding to 5000 in the pod

+
 Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

 

-
kubectl port-forward pod/mypod :5000
+
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
 

-
Forward one or more local ports to a pod. 

-
Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted. 

-
If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and rerun of the command is needed to resume forwarding.

-
Usage

-
$ port-forward TYPE/NAME [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
pod-running-timeout1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 

-

-
proxy

 

-
 To proxy all of the kubernetes api and nothing else, use:

+
 Start a replicated instance of nginx.

 

-
$ kubectl proxy --api-prefix=/
+
kubectl run nginx --image=nginx --replicas=5
 

 

-
 To proxy only part of the kubernetes api and also some static files:

+
 Dry run. Print the corresponding API objects without creating them.

 

-
$ kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
+
kubectl run nginx --image=nginx --dry-run
 

 

-
 The above lets you 'curl localhost:8001/api/v1/pods'. # To proxy the entire kubernetes api at a different root, use:

+
 Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

 

-
$ kubectl proxy --api-prefix=/custom/
+
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
 

 

-
 The above lets you 'curl localhost:8001/custom/api/v1/pods' # Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/

+
 Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

 

-
kubectl proxy --port=8011 --www=./local/www/
+
kubectl run -i -t busybox --image=busybox --restart=Never
 

 

-
 Run a proxy to kubernetes apiserver on an arbitrary local port. # The chosen port for the server will be output to stdout.

+
 Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

 

-
kubectl proxy --port=0
+
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
 

 

-
 Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api # This makes e.g. the pods api available at localhost:8001/k8s-api/v1/pods/

+
 Start the nginx container using a different command and custom arguments.

 

-
kubectl proxy --api-prefix=/k8s-api
+
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
 

-
Creates a proxy server or application-level gateway between localhost and the Kubernetes API Server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote kubernetes API Server port, except for the path matching the static content path.

+

+
 Start the perl container to compute π to 2000 places and print it out.

+

+
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+

+
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+

+
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+
Create and run a particular image, possibly replicated. 

+
Creates a deployment or job to manage the created container(s).

 
Usage

-
$ proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]

+
$ run-container

 
Flags

 
@@ -7065,1317 +6757,223 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
+
-
+
+
-
-
-
-
+
+
+
+
-
-

 
 
 
 
accept-hostsattach
 ^localhost$,^127.0.0.1$,^[::1]$Regular expression for hosts that the proxy should accept. falseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. 
 

 
accept-pathscascade
 ^.*Regular expression for paths that the proxy should accept. trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 
addresscommand
 127.0.0.1The IP address on which to serve on. falseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. 
 

 
api-prefixdry-run
 /Prefix to serve the proxied API under. falseIf true, only print the object that would be sent, without sending it. 
 

 
disable-filterenv[]Environment variables to set in the container 
expose
 
 falseIf true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. If true, a public, external service is created for the container(s) which are run 
 

 
portp8001The port on which to run the proxy. Set to 0 to pick a random port. filenamef[]to use to replace the resource. 
 

 
reject-methodsforce
 ^$Regular expression for HTTP methods that the proxy should reject (example --reject-methods='POST,PUT,PATCH').  falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
reject-pathsgenerator
 ^/api/./pods/./exec,^/api/./pods/./attachRegular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by --accept-paths. The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. 
 

 
unix-socketugrace-period
 Unix socket on which to run the proxy. -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
wwwwhostport
 Also serve static files from the given directory under the specified prefix. -1The host port mapping for the container port. To demonstrate a single-machine container. 
 

 
www-prefixP/static/Prefix to serve static files under, if static file directory is specified. imageThe image for the container to run. 
 

-

-
top

-
Display Resource (CPU/Memory/Storage) usage. 

-
The top command allows you to see the resource consumption for nodes or pods. 

-
This command requires Heapster to be correctly configured and working on the server.

-
Usage

-
$ top

-

-
node

-

-
 Show metrics for all nodes

-

-
kubectl top node
-

-

-
 Show metrics for a given node

-

-
kubectl top node NODE_NAME
-

-
Display Resource (CPU/Memory/Storage) usage of nodes. 

-
The top-node command allows you to see the resource consumption of nodes.

-
Usage

-
$ node [NAME | -l label]

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
+
+
-
-
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
-
-
+
-
-
-
-

 
NameShorthandDefaultUsageimage-pull-policyThe image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server 
 

 
heapster-namespacelabelsl
 kube-systemNamespace Heapster service is located in Comma separated labels to apply to the pod(s). Will override previous values. 
 

 
heapster-portleave-stdin-open
 Port name in service to use falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. 
 

 
heapster-schemelimits
 httpScheme (http or https) to connect to Heapster as The resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. 
 

 
heapster-serviceoutputo
 heapsterName of Heapster service Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
selectorloverrides
 Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

-

-
pod

-

-
 Show metrics for all pods in the default namespace

-

-
kubectl top pod
-

-

-
 Show metrics for all pods in the given namespace

-

-
kubectl top pod --namespace=NAMESPACE
-

-

-
 Show metrics for a given pod and its containers

-

-
kubectl top pod POD_NAME --containers
-

-

-
 Show metrics for the pods defined by label name=myLabel

-

-
kubectl top pod -l name=myLabel
-

-
Display Resource (CPU/Memory/Storage) usage of pods. 

-
The 'top pod' command allows you to see the resource consumption of pods. 

-
Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.

-
Usage

-
$ pod [NAME | -l label]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
all-namespacesfalseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
containersfalseIf present, print usage of containers within a pod. 
heapster-namespacekube-systemNamespace Heapster service is located in 
heapster-portPort name in service to use 
heapster-schemehttpScheme (http or https) to connect to Heapster as 
heapster-serviceheapsterName of Heapster service 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

-
CLUSTER MANAGEMENT

-

-
api-versions

-

-
 Print the supported API versions

-

-
kubectl api-versions
-

-
Print the supported API versions on the server, in the form of "group/version"

-
Usage

-
$ api-versions

-

-
certificate

-
Modify certificate resources.

-
Usage

-
$ certificate SUBCOMMAND

-

-
approve

-
Approve a certificate signing request. 

-
kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR. 

-
SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.

-
Usage

-
$ approve (-f FILENAME | NAME)

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
filenamef[]Filename, directory, or URL to files identifying the resource to update 
outputoOutput mode. Use "-o name" for shorter output (resource/name). 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

-

-
deny

-
Deny a certificate signing request. 

-
kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.

-
Usage

-
$ deny (-f FILENAME | NAME)

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
filenamef[]Filename, directory, or URL to files identifying the resource to update 
outputoOutput mode. Use "-o name" for shorter output (resource/name). 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

-

-
cluster-info

-

-
 Print the address of the master and cluster services

-

-
kubectl cluster-info
-

-
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

-
Usage

-
$ cluster-info

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 

-

-
dump

-

-
 Dump current cluster state to stdout

-

-
kubectl cluster-info dump
-

-

-
 Dump current cluster state to /path/to/cluster-state

-

-
kubectl cluster-info dump --output-directory=/path/to/cluster-state
-

-

-
 Dump all namespaces to stdout

-

-
kubectl cluster-info dump --all-namespaces
-

-

-
 Dump a set of namespaces to /path/to/cluster-state

-

-
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
-

-
Dumps cluster info out suitable for debugging and diagnosing cluster problems.  By default, dumps everything to stdout. You can optionally specify a directory with --output-directory.  If you specify a directory, kubernetes will build a set of files in that directory.  By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. 

-
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name.

-
Usage

-
$ dump

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
all-namespacesfalseIf true, dump all namespaces.  If true, --namespaces is ignored. 
namespaces[]A comma separated list of namespaces to dump. 
output-directoryWhere to output the files.  If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory 
pod-running-timeout20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 

-

-
cordon

-

-
 Mark node "foo" as unschedulable.

-

-
kubectl cordon foo
-

-
Mark node as unschedulable.

-
Usage

-
$ cordon NODE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
dry-runfalseIf true, only print the object that would be sent, without sending it. 
selectorlSelector (label query) to filter on 

-

-
drain

-

-
 Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.

-

-
$ kubectl drain foo --force
-

-

-
 As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.

-

-
$ kubectl drain foo --grace-period=900
-

-
Drain node in preparation for maintenance. 

-
The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the APIServer supports eviction (http://kubernetes.io/docs/admin/disruptions/). Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server).  If there are DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings.  If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet or Job, then drain will not delete any pods unless you use --force.  --force will also allow deletion to proceed if the managing resource of one or more pods is missing. 

-
'drain' waits for graceful termination. You should not operate on the machine until the command completes. 

-
When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. 

-
! http://kubernetes.io/images/docs/kubectl_drain.svg

-
Usage

-
$ drain NODE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
delete-local-datafalseContinue even if there are pods using emptyDir (local data that will be deleted when the node is drained). 
dry-runfalseIf true, only print the object that would be sent, without sending it. 
forcefalseContinue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet. 
grace-period-1Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. 
ignore-daemonsetsfalseIgnore DaemonSet-managed pods. 
pod-selectorLabel selector to filter pods on the node 
selectorlSelector (label query) to filter on 
timeout0sThe length of time to wait before giving up, zero means infinite 

-

-
taint

-

-
 Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. # If a taint with that key and effect already exists, its value is replaced as specified.

-

-
kubectl taint nodes foo dedicated=special-user:NoSchedule
-

-

-
 Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists.

-

-
kubectl taint nodes foo dedicated:NoSchedule-
-

-

-
 Remove from node 'foo' all the taints with key 'dedicated'

-

-
kubectl taint nodes foo dedicated-
-

-

-
 Add a taint with key 'dedicated' on nodes having label mylabel=X

-

-
kubectl taint node -l myLabel=X  dedicated=foo:PreferNoSchedule
-

-
Update the taints on one or more nodes. 

-
    
-
  • A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.  
    • 
-
  • The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  253 characters.  
    • 
-
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
-
  • The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters.  
    • 
-
  • The effect must be NoSchedule, PreferNoSchedule or NoExecute.  
    • 
-
  • Currently taint can only apply to node.
    • 
-

-
Usage

-
$ taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
allfalseSelect all nodes in the cluster 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
overwritefalseIf true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
validatetrueIf true, use a schema to validate the input before sending it 

-

-
uncordon

-

-
 Mark node "foo" as schedulable.

-

-
$ kubectl uncordon foo
-

-
Mark node as schedulable.

-
Usage

-
$ uncordon NODE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
dry-runfalseIf true, only print the object that would be sent, without sending it. 
selectorlSelector (label query) to filter on 

-
KUBECTL SETTINGS AND USAGE

-

-
alpha

-
These commands correspond to alpha features that are not enabled in Kubernetes clusters by default.

-
Usage

-
$ alpha

-

-
diff

-

-
 Diff resources included in pod.json. By default, it will diff LOCAL and LIVE versions

-

-
kubectl alpha diff -f pod.json
-

-

-
 When one version is specified, diff that version against LIVE

-

-
cat service.yaml | kubectl alpha diff -f - MERGED
-

-

-
 Or specify both versions

-

-
kubectl alpha diff -f pod.json -f service.yaml LAST LOCAL
-

-
Diff configurations specified by filename or stdin between their local, last-applied, live and/or "merged" versions. 

-
LOCAL and LIVE versions are diffed by default. Other available keywords are MERGED and LAST. 

-
Output is always YAML. 

-
KUBERNETES EXTERNAL DIFF environment variable can be used to select your own diff command. By default, the "diff" command available in your path will be run with "-u" (unicode) and "-N" (treat new files as empty) options.

-
Usage

-
$ diff -f FILENAME

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
filenamef[]Filename, directory, or URL to files contains the configuration to diff 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

-

-
completion

-

-
 Installing bash completion on macOS using homebrew ## If running Bash 3.2 included with macOS

-

-
brew install bash-completion
-

-

-
 or, if running Bash 4.1+

-

-
brew install bash-completion@2
-

-

-
 If kubectl is installed via homebrew, this should start working immediately. ## If you've installed via other means, you may need add the completion to your completion directory

-

-
kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl
-

-

-
 Installing bash completion on Linux ## Load the kubectl completion code for bash into the current shell

-

-
source <(kubectl completion bash)
-

-

-
 Write bash completion code to a file and source if from .bash_profile

-

-
kubectl completion bash > ~/.kube/completion.bash.inc
-printf "
-

-

-
 Kubectl shell completion

-

-
source '$HOME/.kube/completion.bash.inc'
-" >> $HOME/.bash_profile
-source $HOME/.bash_profile
-

-

-
 Load the kubectl completion code for zsh[1] into the current shell

-

-
source <(kubectl completion zsh)
-

-

-
 Set the kubectl completion code for zsh[1] to autoload on startup

-

-
kubectl completion zsh > "${fpath[1]}/_kubectl"
-

-
Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubectl commands.  This can be done by sourcing it from the .bash _profile. 

-
Detailed instructions on how to do this are available here: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion 

-
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2

-
Usage

-
$ completion SHELL

-

-
config

-
Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" 

-
The loading order follows these rules: 

-
    
-
  1. If the --kubeconfig flag is set, then only that file is loaded.  The flag may only be set once and no merging takes place.  
    2. 
-
  2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system).  These paths are merged.  When a value is modified, it is modified in the file that defines the stanza.  When a value is created, it is created in the first file that exists.  If no files in the chain exist, then it creates the last file in the list.  
    3. 
-
  3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
    4. 
-

-
Usage

-
$ config SUBCOMMAND

-

-
current-context

-

-
 Display the current-context

-

-
kubectl config current-context
-

-
Displays the current-context

-
Usage

-
$ current-context

-

-
delete-cluster

-

-
 Delete the minikube cluster

-

-
kubectl config delete-cluster minikube
-

-
Delete the specified cluster from the kubeconfig

-
Usage

-
$ delete-cluster NAME

-

-
delete-context

-

-
 Delete the context for the minikube cluster

-

-
kubectl config delete-context minikube
-

-
Delete the specified context from the kubeconfig

-
Usage

-
$ delete-context NAME

-

-
get-clusters

-

-
 List the clusters kubectl knows about

-

-
kubectl config get-clusters
-

-
Display clusters defined in the kubeconfig.

-
Usage

-
$ get-clusters

-

-
get-contexts

-

-
 List all the contexts in your kubeconfig file

-

-
kubectl config get-contexts
-

-

-
 Describe one context in your kubeconfig file.

-

-
kubectl config get-contexts my-context
-

-
Displays one or many contexts from the kubeconfig file.

-
Usage

-
$ get-contexts [(-o|--output=)name)]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 

-

-
rename-context

-

-
 Rename the context 'old-name' to 'new-name' in your kubeconfig file

-

-
kubectl config rename-context old-name new-name
-

-
Renames a context from the kubeconfig file. 

-
CONTEXT _NAME is the context name that you wish change. 

-
NEW _NAME is the new name you wish to set. 

-
Note: In case the context being renamed is the 'current-context', this field will also be updated.

-
Usage

-
$ rename-context CONTEXT_NAME NEW_NAME

-

-
set

-
Sets an individual value in a kubeconfig file 

-
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots. 

-
PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.

-
Usage

-
$ set PROPERTY_NAME PROPERTY_VALUE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
set-raw-bytesfalseWhen writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding. 

-

-
set-cluster

-

-
 Set only the server field on the e2e cluster entry without touching other values.

-

-
kubectl config set-cluster e2e --server=https://1.2.3.4
-

-

-
 Embed certificate authority data for the e2e cluster entry

-

-
kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
-

-

-
 Disable cert checking for the dev cluster entry

-

-
kubectl config set-cluster e2e --insecure-skip-tls-verify=true
-

-
Sets a cluster entry in kubeconfig. 

-
Specifying a name that already exists will merge new fields on top of existing values for those fields.

-
Usage

-
$ set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
embed-certsfalseembed-certs for the cluster entry in kubeconfig 

-

-
set-context

-

-
 Set the user field on the gce context entry without touching other values

-

-
kubectl config set-context gce --user=cluster-admin
-

-
Sets a context entry in kubeconfig 

-
Specifying a name that already exists will merge new fields on top of existing values for those fields.

-
Usage

-
$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]

-

-
set-credentials

-

-
 Set only the "client-key" field on the "cluster-admin" # entry, without touching other values:

-

-
kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
-

-

-
 Set basic auth for the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
-

-

-
 Embed client certificate data in the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
-

-

-
 Enable the Google Compute Platform auth provider for the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --auth-provider=gcp
-

-

-
 Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args

-

-
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
-

-

-
 Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
-

-
Sets a user entry in kubeconfig 

-
Specifying a name that already exists will merge new fields on top of existing values. 

-
  Client-certificate flags:
-  --client-certificate=certfile --client-key=keyfile

-
  Bearer token flags:
-    --token=bearer_token

-
  Basic auth flags:
-    --username=basic_user --password=basic_password

-
Bearer token and basic auth are mutually exclusive.

-
Usage

-
$ set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
+
-
-
-
-
-
NameShorthandDefaultUsage
auth-provider
 Auth provider for the user entry in kubeconfig An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
 

 
auth-provider-argpod-running-timeout
 []'key=value' arguments for the auth provider 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

 
embed-certsport
 falseEmbed client cert/key for the user entry in kubeconfig 

-

-
unset

-

-
 Unset the current-context.

-

-
kubectl config unset current-context
-

-

-
 Unset namespace in foo context.

-

-
kubectl config unset contexts.foo.namespace
-

-
Unsets an individual value in a kubeconfig file 

-
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots.

-
Usage

-
$ unset PROPERTY_NAME

-

-
use-context

-

-
 Use the context for the minikube cluster

-

-
kubectl config use-context minikube
-

-
Sets the current-context in a kubeconfig file

-
Usage

-
$ use-context CONTEXT_NAME

-

-
view

-

-
 Show Merged kubeconfig settings.

-

-
kubectl config view
-

-

-
 Get the password for the e2e user

-

-
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
-

-
Display merged kubeconfig settings or a specified kubeconfig file. 

-
You can use --output jsonpath={...} to extract specific values using a jsonpath expression.

-
Usage

-
$ view

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
-
+
-
+
+
-
+
-
+
-
-
NameShorthandDefaultUsage
allow-missing-template-keys
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. 
 

 
flattenquiet
 
 falseFlatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files) 
mergetrueMerge the full hierarchy of kubeconfig files If true, suppress prompt messages. 
 

 
minifyrecord
 
 falseRemove all information not used by current-context from the output Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
no-headersrecursiveR
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. replicasr1Number of replicas to create for this container. Default is 1. 
 

 
output-versionrequests
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
 

 
rawrestart
 falseDisplay raw byte data 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. 
 

 
show-labelsrm
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, delete resources created in this command for attached containers. 
 

 
sort-bysave-config
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
templateschedule
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. A schedule in the Cron format the job should be run with. 
 

-

-
explain

-

-
 Get the documentation of the resource and its fields

-

-
kubectl explain pods
-

-

-
 Get the documentation of a specific field of a resource

-

-
kubectl explain pods.spec.containers
-

-
List the fields for supported resources 

-
This command describes the fields associated with each supported API resource. Fields are identified via a simple JSONPath identifier: 

-
  .[.]

-
Add the --recursive flag to display all of the fields at once without descriptions. Information about each field is retrieved from the server in OpenAPI format.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

-
Usage

-
$ explain RESOURCE

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
-

 
NameShorthandDefaultUsageservice-generatorservice/v2The name of the generator to use for creating a service.  Only used if --expose is true 
 

 
api-versionservice-overrides
 
 Get different explanations for particular API version An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. 
 

 
include-extended-apisserviceaccount
 trueIf true, include definitions of new APIs via calls to the API server. [default true] Service account to set in the pod spec 
 

 
recursivestdini
 falsePrint the fields of fields (Currently only 1 level deep) Keep stdin open on the container(s) in the pod, even if nothing is attached. 
 

-

-
options

-

-
 Print flags inherited by all commands

-

-
kubectl options
-

-
Print the list of flags inherited by all commands

-
Usage

-
$ options

-

-
version

-

-
 Print the client and server versions for the current context

-

-
kubectl version
-

-
Print the client and server version information for the current context

-
Usage

-
$ version

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
-
+
+
-
-
-
-
-
-
-
+
-
+
-
+

 
NameShorthandDefaultUsagetimeout0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
clientcttyt
 falseClient version only (no server required). 
outputoOne of 'yaml' or 'json'. Allocated a TTY for each container in the pod. 
 

 
shortwait
 
 falsePrint just the version number. If true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

-

-
plugin

-
Runs a command-line plugin. 

-
Plugins are subcommands that are not part of the major command-line distribution and can even be provided by third-parties. Please refer to the documentation and examples for more information about how to install and write your own plugins.

-
Usage

-
$ plugin NAME

-
DEPRECATED COMMANDS
diff --git a/static/docs/reference/generated/kubectl/navData.js b/static/docs/reference/generated/kubectl/navData.js index 213410f5107cc..4df43b4b82ea0 100644 --- a/static/docs/reference/generated/kubectl/navData.js +++ b/static/docs/reference/generated/kubectl/navData.js @@ -1 +1 @@ -(function(){navData = {"toc":[{"section":"-strong-deprecated-commands-strong-","subsections":[]},{"section":"plugin","subsections":[]},{"section":"version","subsections":[]},{"section":"options","subsections":[]},{"section":"explain","subsections":[]},{"section":"config","subsections":[{"section":"-em-view-em-"},{"section":"-em-use-context-em-"},{"section":"-em-unset-em-"},{"section":"-em-set-credentials-em-"},{"section":"-em-set-context-em-"},{"section":"-em-set-cluster-em-"},{"section":"-em-set-em-"},{"section":"-em-rename-context-em-"},{"section":"-em-get-contexts-em-"},{"section":"-em-get-clusters-em-"},{"section":"-em-delete-context-em-"},{"section":"-em-delete-cluster-em-"},{"section":"-em-current-context-em-"}]},{"section":"completion","subsections":[]},{"section":"alpha","subsections":[{"section":"-em-diff-em-"}]},{"section":"-strong-kubectl-settings-and-usage-strong-","subsections":[]},{"section":"uncordon","subsections":[]},{"section":"taint","subsections":[]},{"section":"drain","subsections":[]},{"section":"cordon","subsections":[]},{"section":"cluster-info","subsections":[{"section":"-em-dump-em-"}]},{"section":"certificate","subsections":[{"section":"-em-deny-em-"},{"section":"-em-approve-em-"}]},{"section":"api-versions","subsections":[]},{"section":"-strong-cluster-management-strong-","subsections":[]},{"section":"top","subsections":[{"section":"-em-pod-em-"},{"section":"-em-node-em-"}]},{"section":"proxy","subsections":[]},{"section":"port-forward","subsections":[]},{"section":"logs","subsections":[]},{"section":"exec","subsections":[]},{"section":"describe","subsections":[]},{"section":"cp","subsections":[]},{"section":"auth","subsections":[{"section":"-em-reconcile-em-"},{"section":"-em-can-i-em-"}]},{"section":"attach","subsections":[]},{"section":"-strong-working-with-apps-strong-","subsections":[]},{"section":"apply","subsections":[{"section":"-em-view-last-applied-em-"},{"section":"-em-set-last-applied-em-"},{"section":"-em-edit-last-applied-em-"}]},{"section":"-strong-declarative-app-management-strong-","subsections":[]},{"section":"set","subsections":[{"section":"-em-subject-em-"},{"section":"-em-serviceaccount-em--1"},{"section":"-em-selector-em-"},{"section":"-em-resources-em-"},{"section":"-em-image-em-"},{"section":"-em-env-em-"}]},{"section":"scale","subsections":[]},{"section":"rollout","subsections":[{"section":"-em-undo-em-"},{"section":"-em-status-em-"},{"section":"-em-resume-em-"},{"section":"-em-pause-em-"},{"section":"-em-history-em-"}]},{"section":"rolling-update","subsections":[]},{"section":"replace","subsections":[]},{"section":"patch","subsections":[]},{"section":"label","subsections":[]},{"section":"get","subsections":[]},{"section":"edit","subsections":[]},{"section":"delete","subsections":[]},{"section":"create","subsections":[{"section":"-em-serviceaccount-em-"},{"section":"-em-service-nodeport-em-"},{"section":"-em-service-loadbalancer-em-"},{"section":"-em-service-externalname-em-"},{"section":"-em-service-clusterip-em-"},{"section":"-em-service-em-"},{"section":"-em-secret-tls-em-"},{"section":"-em-secret-generic-em-"},{"section":"-em-secret-docker-registry-em-"},{"section":"-em-secret-em-"},{"section":"-em-rolebinding-em-"},{"section":"-em-role-em-"},{"section":"-em-quota-em-"},{"section":"-em-priorityclass-em-"},{"section":"-em-poddisruptionbudget-em-"},{"section":"-em-namespace-em-"},{"section":"-em-job-em-"},{"section":"-em-deployment-em-"},{"section":"-em-configmap-em-"},{"section":"-em-clusterrolebinding-em-"},{"section":"-em-clusterrole-em-"}]},{"section":"convert","subsections":[]},{"section":"autoscale","subsections":[]},{"section":"annotate","subsections":[]},{"section":"-strong-app-management-strong-","subsections":[]},{"section":"expose","subsections":[]},{"section":"run-container","subsections":[]},{"section":"run","subsections":[]},{"section":"-strong-getting-started-strong-","subsections":[]}],"flatToc":["-strong-deprecated-commands-strong-","plugin","version","options","explain","-em-view-em-","-em-use-context-em-","-em-unset-em-","-em-set-credentials-em-","-em-set-context-em-","-em-set-cluster-em-","-em-set-em-","-em-rename-context-em-","-em-get-contexts-em-","-em-get-clusters-em-","-em-delete-context-em-","-em-delete-cluster-em-","-em-current-context-em-","config","completion","-em-diff-em-","alpha","-strong-kubectl-settings-and-usage-strong-","uncordon","taint","drain","cordon","-em-dump-em-","cluster-info","-em-deny-em-","-em-approve-em-","certificate","api-versions","-strong-cluster-management-strong-","-em-pod-em-","-em-node-em-","top","proxy","port-forward","logs","exec","describe","cp","-em-reconcile-em-","-em-can-i-em-","auth","attach","-strong-working-with-apps-strong-","-em-view-last-applied-em-","-em-set-last-applied-em-","-em-edit-last-applied-em-","apply","-strong-declarative-app-management-strong-","-em-subject-em-","-em-serviceaccount-em--1","-em-selector-em-","-em-resources-em-","-em-image-em-","-em-env-em-","set","scale","-em-undo-em-","-em-status-em-","-em-resume-em-","-em-pause-em-","-em-history-em-","rollout","rolling-update","replace","patch","label","get","edit","delete","-em-serviceaccount-em-","-em-service-nodeport-em-","-em-service-loadbalancer-em-","-em-service-externalname-em-","-em-service-clusterip-em-","-em-service-em-","-em-secret-tls-em-","-em-secret-generic-em-","-em-secret-docker-registry-em-","-em-secret-em-","-em-rolebinding-em-","-em-role-em-","-em-quota-em-","-em-priorityclass-em-","-em-poddisruptionbudget-em-","-em-namespace-em-","-em-job-em-","-em-deployment-em-","-em-configmap-em-","-em-clusterrolebinding-em-","-em-clusterrole-em-","create","convert","autoscale","annotate","-strong-app-management-strong-","expose","run-container","run","-strong-getting-started-strong-"]};})(); \ No newline at end of file +(function(){navData = {"toc":[{"section":"run-container","subsections":[]},{"section":"rolling-update","subsections":[]},{"section":"-strong-deprecated-commands-strong-","subsections":[]},{"section":"version","subsections":[]},{"section":"plugin","subsections":[]},{"section":"options","subsections":[]},{"section":"explain","subsections":[]},{"section":"config","subsections":[{"section":"-em-view-em-"},{"section":"-em-use-context-em-"},{"section":"-em-unset-em-"},{"section":"-em-set-credentials-em-"},{"section":"-em-set-context-em-"},{"section":"-em-set-cluster-em-"},{"section":"-em-set-em-"},{"section":"-em-rename-context-em-"},{"section":"-em-get-contexts-em-"},{"section":"-em-get-clusters-em-"},{"section":"-em-delete-context-em-"},{"section":"-em-delete-cluster-em-"},{"section":"-em-current-context-em-"}]},{"section":"completion","subsections":[]},{"section":"api-resources","subsections":[]},{"section":"alpha","subsections":[{"section":"-em-diff-em-"}]},{"section":"-strong-kubectl-settings-and-usage-strong-","subsections":[]},{"section":"uncordon","subsections":[]},{"section":"taint","subsections":[]},{"section":"drain","subsections":[]},{"section":"cordon","subsections":[]},{"section":"cluster-info","subsections":[{"section":"-em-dump-em-"}]},{"section":"certificate","subsections":[{"section":"-em-deny-em-"},{"section":"-em-approve-em-"}]},{"section":"api-versions","subsections":[]},{"section":"-strong-cluster-management-strong-","subsections":[]},{"section":"top","subsections":[{"section":"-em-pod-em-"},{"section":"-em-node-em-"}]},{"section":"proxy","subsections":[]},{"section":"port-forward","subsections":[]},{"section":"logs","subsections":[]},{"section":"exec","subsections":[]},{"section":"describe","subsections":[]},{"section":"cp","subsections":[]},{"section":"auth","subsections":[{"section":"-em-reconcile-em-"},{"section":"-em-can-i-em-"}]},{"section":"attach","subsections":[]},{"section":"-strong-working-with-apps-strong-","subsections":[]},{"section":"wait","subsections":[]},{"section":"set","subsections":[{"section":"-em-subject-em-"},{"section":"-em-serviceaccount-em--1"},{"section":"-em-selector-em-"},{"section":"-em-resources-em-"},{"section":"-em-image-em-"},{"section":"-em-env-em-"}]},{"section":"scale","subsections":[]},{"section":"rollout","subsections":[{"section":"-em-undo-em-"},{"section":"-em-status-em-"},{"section":"-em-resume-em-"},{"section":"-em-pause-em-"},{"section":"-em-history-em-"}]},{"section":"replace","subsections":[]},{"section":"patch","subsections":[]},{"section":"label","subsections":[]},{"section":"edit","subsections":[]},{"section":"convert","subsections":[]},{"section":"autoscale","subsections":[]},{"section":"annotate","subsections":[]},{"section":"apply","subsections":[{"section":"-em-view-last-applied-em-"},{"section":"-em-set-last-applied-em-"},{"section":"-em-edit-last-applied-em-"}]},{"section":"-strong-app-management-strong-","subsections":[]},{"section":"delete","subsections":[]},{"section":"expose","subsections":[]},{"section":"run","subsections":[]},{"section":"get","subsections":[]},{"section":"create","subsections":[{"section":"-em-serviceaccount-em-"},{"section":"-em-service-nodeport-em-"},{"section":"-em-service-loadbalancer-em-"},{"section":"-em-service-externalname-em-"},{"section":"-em-service-clusterip-em-"},{"section":"-em-service-em-"},{"section":"-em-secret-tls-em-"},{"section":"-em-secret-generic-em-"},{"section":"-em-secret-docker-registry-em-"},{"section":"-em-secret-em-"},{"section":"-em-rolebinding-em-"},{"section":"-em-role-em-"},{"section":"-em-quota-em-"},{"section":"-em-priorityclass-em-"},{"section":"-em-poddisruptionbudget-em-"},{"section":"-em-namespace-em-"},{"section":"-em-job-em-"},{"section":"-em-deployment-em-"},{"section":"-em-configmap-em-"},{"section":"-em-clusterrolebinding-em-"},{"section":"-em-clusterrole-em-"}]},{"section":"-strong-getting-started-strong-","subsections":[]}],"flatToc":["run-container","rolling-update","-strong-deprecated-commands-strong-","version","plugin","options","explain","-em-view-em-","-em-use-context-em-","-em-unset-em-","-em-set-credentials-em-","-em-set-context-em-","-em-set-cluster-em-","-em-set-em-","-em-rename-context-em-","-em-get-contexts-em-","-em-get-clusters-em-","-em-delete-context-em-","-em-delete-cluster-em-","-em-current-context-em-","config","completion","api-resources","-em-diff-em-","alpha","-strong-kubectl-settings-and-usage-strong-","uncordon","taint","drain","cordon","-em-dump-em-","cluster-info","-em-deny-em-","-em-approve-em-","certificate","api-versions","-strong-cluster-management-strong-","-em-pod-em-","-em-node-em-","top","proxy","port-forward","logs","exec","describe","cp","-em-reconcile-em-","-em-can-i-em-","auth","attach","-strong-working-with-apps-strong-","wait","-em-subject-em-","-em-serviceaccount-em--1","-em-selector-em-","-em-resources-em-","-em-image-em-","-em-env-em-","set","scale","-em-undo-em-","-em-status-em-","-em-resume-em-","-em-pause-em-","-em-history-em-","rollout","replace","patch","label","edit","convert","autoscale","annotate","-em-view-last-applied-em-","-em-set-last-applied-em-","-em-edit-last-applied-em-","apply","-strong-app-management-strong-","delete","expose","run","get","-em-serviceaccount-em-","-em-service-nodeport-em-","-em-service-loadbalancer-em-","-em-service-externalname-em-","-em-service-clusterip-em-","-em-service-em-","-em-secret-tls-em-","-em-secret-generic-em-","-em-secret-docker-registry-em-","-em-secret-em-","-em-rolebinding-em-","-em-role-em-","-em-quota-em-","-em-priorityclass-em-","-em-poddisruptionbudget-em-","-em-namespace-em-","-em-job-em-","-em-deployment-em-","-em-configmap-em-","-em-clusterrolebinding-em-","-em-clusterrole-em-","create","-strong-getting-started-strong-"]};})(); \ No newline at end of file diff --git a/static/docs/reference/generated/kubectl/scroll.js b/static/docs/reference/generated/kubectl/scroll.js index 6639f62895616..67fee8729e449 100644 --- a/static/docs/reference/generated/kubectl/scroll.js +++ b/static/docs/reference/generated/kubectl/scroll.js @@ -187,10 +187,10 @@ $(document).ready(function() { var scrollPosition = $(window).scrollTop(); scrollActions(scrollPosition); checkActiveElement(flatToc, scrollPosition); - // TODO: prevent scroll on sidebar from propagating to window + // TODO: prevent scroll on sidebar from propogating to window $(window).on('scroll', function(event) { var scrollPosition = $(window).scrollTop(); var activeSectionTokens = scrollActions(scrollPosition); var activeElemToken = checkActiveElement(flatToc, scrollPosition); }); -}); +}); \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/index.html b/static/docs/reference/generated/kubernetes-api/v1.11/index.html new file mode 100755 index 0000000000000..e427398de5707 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/index.html @@ -0,0 +1,113523 @@ + + + + +Kubernetes API Reference Docs + + + + + + + + + +
+
  • kubectl
  • curl
+

API OVERVIEW

+

Welcome to the Kubernetes API. You can use the Kubernetes API to read +and write Kubernetes resource objects via a Kubernetes API endpoint.

+

Resource Categories

+

This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions.

+

Workloads are objects you use to manage and run your containers on the cluster.

+

Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service.

+

Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container.

+

Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators.

+

Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads.

+
+

Resource Objects

+

Resource objects typically have 3 components:

+
    +
  • ResourceSpec: This is defined by the user and describes the desired state of system. Fill this in when creating or updating an +object.
    • +
  • ResourceStatus: This is filled in by the server and reports the current state of the system. Only kubernetes components should fill +this in
    • +
  • Resource ObjectMeta: This is metadata about the resource, such as its name, type, api version, annotations, and labels. This contains +fields that maybe updated both by the end user and the system (e.g. annotations)
    • +
+
+

Resource Operations

+

Most resources provide the following Operations:

+

Create:

+

Create operations will create the resource in the storage backend. After a resource is create the system will apply +the desired state.

+

Update:

+

Updates come in 2 forms: Replace and Patch

+

Replace: +Replacing a resource object will update the resource by replacing the existing spec with the provided one. For +read-then-write operations this is safe because an optimistic lock failure will occur if the resource was modified +between the read and write. Note: The ResourceStatus will be ignored by the system and will not be updated. +To update the status, one must invoke the specific status update operation.

+

Note: Replacing a resource object may not result immediately in changes being propagated to downstream objects. For instance +replacing a ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are +restarted out of band.

+

Patch: +Patch will apply a change to a specific field. How the change is merged is defined per field. Lists may either be +replaced or merged. Merging lists will not preserve ordering.

+

Patches will never cause optimistic locking failures, and the last write will win. Patches are recommended + when the full state is not read before an update, or when failing on optimistic locking is undesirable. When patching + complex types, arrays and maps, how the patch is applied is defined on a per-field basis and may either replace + the field's current value, or merge the contents into the current value.

+

Read

+

Reads come in 3 forms: Get, List and Watch

+

Get: Get will retrieve a specific resource object by name.

+

List: List will retrieve all resource objects of a specific type within a namespace, and the results can be restricted to resources matching a selector query.

+

List All Namespaces: Like List but retrieves resources across all namespaces.

+

Watch: Watch will stream results for an object(s) as it is updated. Similar to a callback, watch is used to respond to resource changes.

+

Delete

+

Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See +notes on specific resource objects for details.

+

Additional Operations

+

Resources may define additional operations specific to that resource type.

+

Rollback: Rollback a PodTemplate to a previous version. Only available for some resource types.

+

Read / Write Scale: Read or Update the number of replicas for the given resource. Only available for some resource types.

+

Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations.

+
+

WORKLOADS

+

Workloads resources are responsible for managing and running your containers on the cluster. Containers are created +by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or +persistent storage Volumes and Configuration or Secret data injected into the +container.

+

The most common Controllers are:

+
    +
  • Deployments for stateless persistent apps (e.g. http servers)
    • +
  • StatefulSets for stateful persistent apps (e.g. databases)
    • +
  • Jobs for run-to-completion apps (e.g. batch jobs).
    • +
+
+
+

Container v1 core

+
+

Container Config to run nginx (must be embedded in a PodSpec to run).

+
+

+name: nginx
+# Run the nginx:1.10 image
+image: nginx:1.10
+
+
+

Container Config to run nginx (must be embedded in a PodSpec to run).

+
+

+name: nginx
+# Run the nginx:1.10 image
+image: nginx:1.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Container
+ + + + + + +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
args
string array		Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
command
string array		Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
env
EnvVar array
patch type: merge
patch merge key: name		List of environment variables to set in the container. Cannot be updated.
envFrom
EnvFromSource array		List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
image
string		Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
imagePullPolicy
string		Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
lifecycle
Lifecycle		Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe
Probe		Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
name
string		Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports
ContainerPort array
patch type: merge
patch merge key: containerPort		List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
readinessProbe
Probe		Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resources
ResourceRequirements		Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
securityContext
SecurityContext		Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
stdin
boolean		Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce
boolean		Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
terminationMessagePath
string		Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicy
string		Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
tty
boolean		Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices
VolumeDevice array
patch type: merge
patch merge key: devicePath		volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.
volumeMounts
VolumeMount array
patch type: merge
patch merge key: mountPath		Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDir
string		Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
+

ContainerStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
containerID
string		Container's ID in the format 'docker://<container_id>'.
image
string		The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
imageID
string		ImageID of the container's image.
lastState
ContainerState		Details about the container's last termination condition.
name
string		This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
ready
boolean		Specifies whether the container has passed its readiness probe.
restartCount
integer		The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
state
ContainerState		Details about the container's current condition.
+
+

CronJob v1beta1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv1beta1CronJob
+ + + +

CronJob represents the configuration of a single cron job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
CronJobSpec		Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
CronJobStatus		Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

CronJobSpec v1beta1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
concurrencyPolicy
string		Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
failedJobsHistoryLimit
integer		The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
jobTemplate
JobTemplateSpec		Specifies the job that will be created when executing a CronJob.
schedule
string		The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
startingDeadlineSeconds
integer		Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
successfulJobsHistoryLimit
integer		The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
suspend
boolean		This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
+

CronJobStatus v1beta1 batch

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
active
ObjectReference array		A list of pointers to currently running jobs.
lastScheduleTime
Time		Information when was the last time the job was successfully scheduled.
+

CronJobList v1beta1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
CronJob array		items is the list of CronJobs.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a CronJob

+

HTTP Request

+

POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
201
CronJob		Created
202
CronJob		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified CronJob

+

HTTP Request

+

PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified CronJob

+

HTTP Request

+

PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
201
CronJob		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a CronJob

+

HTTP Request

+

DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of CronJob

+

HTTP Request

+

DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJobList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJobList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/watch/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified CronJob

+

HTTP Request

+

PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified CronJob

+

HTTP Request

+

PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
201
CronJob		Created
+
+

DaemonSet v1 apps

+
+

DaemonSet Config to print the hostname on each Node in the cluster every 10 seconds.

+
+

+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  # Unique key of the DaemonSet instance
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      # This container is run once on each Node in the cluster
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        # This script is run through `sh -c <script>`
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+
+
+

DaemonSet Config to print the hostname on each Node in the cluster every 10 seconds.

+
+

+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  # Unique key of the DaemonSet instance
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      # This container is run once on each Node in the cluster
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        # This script is run through `sh -c <script>`
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1DaemonSet
+ + + +

DaemonSet represents the configuration of a daemon set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
DaemonSetSpec		The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
DaemonSetStatus		The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

DaemonSetSpec v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		The minimum number of seconds for which a newly created DaemonSet 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).
revisionHistoryLimit
integer		The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector		A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		An 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: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
updateStrategy
DaemonSetUpdateStrategy		An update strategy to replace existing DaemonSet pods with new pods.
+

DaemonSetStatus v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer		Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
DaemonSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer		The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer		The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer		The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer		The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer		The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer		The total number of nodes that are running updated daemon pod
+

DaemonSetList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
DaemonSet array		A list of daemon sets.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

RollingUpdateDaemonSet v1 apps

+ + + + + + + + + + + + + + + +
FieldDescription
maxUnavailableThe maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets
+
+
+

Output

+
+

+daemonset "daemonset-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "DaemonSet",
+  "apiVersion": "extensions/v1beta1",
+  "metadata": {
+    "name": "daemonset-example",
+    "namespace": "default",
+    "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+    "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+    "resourceVersion": "3558",
+    "generation": 1,
+    "creationTimestamp": "2016-11-22T18:35:09Z",
+    "labels": {
+      "app": "daemonset-example"
+    }
+  },
+  "spec": {
+    "selector": {
+      "matchLabels": {
+        "app": "daemonset-example"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "daemonset-example"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "daemonset-example",
+            "image": "ubuntu:trusty",
+            "command": [
+              "/bin/sh"
+            ],
+            "args": [
+              "-c",
+              "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    }
+  },
+  "status": {
+    "currentNumberScheduled": 0,
+    "numberMisscheduled": 0,
+    "desiredNumberScheduled": 0
+  }
+}
+
+

create a DaemonSet

+

HTTP Request

+

POST /apis/apps/v1/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
DaemonSet		Created
202
DaemonSet		Accepted
200
DaemonSet		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified DaemonSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified DaemonSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
201
DaemonSet		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete daemonset daemonset-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example'
+
+
+

Output

+
+

+daemonset "daemonset-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a DaemonSet

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of DaemonSet

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get daemonset daemonset-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example
+
+
+

Output

+
+

+
+
+

Response Body

+
+

+
+

read the specified DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/watch/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified DaemonSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified DaemonSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
201
DaemonSet		Created
+
+

Deployment v1 apps

+
+

Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).

+
+

+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  # Unique key of the Deployment instance
+  name: deployment-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        # Apply this label to pods and default
+        # the Deployment label selector to this value
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        # Run this image
+        image: nginx:1.10
+
+
+

Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).

+
+

+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  # Unique key of the Deployment instance
+  name: deployment-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        # Apply this label to pods and default
+        # the Deployment label selector to this value
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        # Run this image
+        image: nginx:1.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1Deployment
+ + + +

Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean		Indicates that the deployment is paused.
progressDeadlineSeconds
integer		The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
replicas
integer		Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit
integer		The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector		Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
strategy
DeploymentStrategy		The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec		Template describes the pods that will be created.
+

DeploymentStatus v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
collisionCount
integer		Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
conditions
DeploymentCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Deployment array		Items is the list of Deployments.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1 apps

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDeployment		Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type
string		Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+

RollingUpdateDeployment v1 apps

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
maxSurgeThe maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
maxUnavailableThe maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments
+
+
+

Output

+
+

+deployment "deployment-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2118306",
+    "generation": 1,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {}
+}
+
+

create a Deployment

+

HTTP Request

+

POST /apis/apps/v1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
202
Deployment		Accepted
+

Patch

+
+

kubectl Command

+
+

+$ kubectl patch deployment deployment-example -p \
+    '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+    "resourceVersion": "164489",
+    "generation": 11,
+    "creationTimestamp": "2016-11-22T20:00:50Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "5"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 10,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

partially update the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' | kubectl replace -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+deployment "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2119082",
+    "generation": 5,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

replace the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete deployment deployment-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+deployment "deployment-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a Deployment

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Deployment

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

read the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

List

+
+

kubectl Command

+
+

+$ kubectl get deployment -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments'
+
+
+

Output

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+
+

Response Body

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

Watch

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example --watch -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/watch/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+
+

Response Body

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+

watch changes to an object of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

Job v1 batch

+
+

Job Config to print pi up to 2000 digits (then exit).

+
+

+apiVersion: batch/v1
+kind: Job
+metadata:
+  # Unique key of the Job instance
+  name: example-job
+spec:
+  template:
+    metadata:
+      name: example-job
+    spec:
+      containers:
+      - name: pi
+        image: perl
+        command: ["perl"]
+        args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
+      # Do not restart containers after they exit
+      restartPolicy: Never
+
+
+

Job Config to print pi up to 2000 digits (then exit).

+
+

+apiVersion: batch/v1
+kind: Job
+metadata:
+  # Unique key of the Job instance
+  name: example-job
+spec:
+  template:
+    metadata:
+      name: example-job
+    spec:
+      containers:
+      - name: pi
+        image: perl
+        command: ["perl"]
+        args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
+      # Do not restart containers after they exit
+      restartPolicy: Never
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv1Job
+

Job represents the configuration of a single job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
JobSpec		Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
JobStatus		Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

JobSpec v1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
activeDeadlineSeconds
integer		Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
backoffLimit
integer		Specifies the number of retries before marking this job failed. Defaults to 6
completions
integer		Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
manualSelector
boolean		manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
parallelism
integer		Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
selector
LabelSelector		A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
+

JobStatus v1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
active
integer		The number of actively running pods.
completionTime
Time		Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
conditions
JobCondition array
patch type: merge
patch merge key: type		The latest available observations of an object's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
failed
integer		The number of pods which reached phase Failed.
startTime
Time		Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
succeeded
integer		The number of pods which reached phase Succeeded.
+

JobList v1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Job array		items is the list of Jobs.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: batch/v1
+kind: Job
+metadata:
+  name: example-job
+spec:
+  template:
+    metadata:
+      name: example-job
+    spec:
+      containers:
+      - name: pi
+        image: perl
+        command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
+      restartPolicy: Never
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: example-job
+spec:
+  template:
+    metadata:
+      name: example-job
+    spec:
+      containers:
+      - name: pi
+        image: perl
+        command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
+      restartPolicy: Never
+' http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs
+
+
+

Output

+
+

+job "example-job" created
+
+
+

Response Body

+
+

+{
+  "kind": "Job",
+  "apiVersion": "batch/v1",
+  "metadata": {
+    "name": "example-job",
+    "namespace": "default",
+    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+    "resourceVersion": "7479",
+    "creationTimestamp": "2016-11-04T18:45:25Z"
+  },
+  "spec": {
+    "parallelism": 1,
+    "completions": 1,
+    "selector": {
+      "matchLabels": {
+        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+      }
+    },
+    "template": {
+      "metadata": {
+        "name": "example-job",
+        "creationTimestamp": null,
+        "labels": {
+          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+          "job-name": "example-job"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "pi",
+            "image": "perl",
+            "command": [
+              "perl",
+              "-Mbignum=bpi",
+              "-wle",
+              "print bpi(2000)"
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "Always"
+          }
+        ],
+        "restartPolicy": "Never",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    }
+  },
+  "status": {}
+}
+
+

create a Job

+

HTTP Request

+

POST /apis/batch/v1/namespaces/{namespace}/jobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Job
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
Job		Accepted
200
Job		OK
201
Job		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Job

+

HTTP Request

+

PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Job		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Job

+

HTTP Request

+

PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Job
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Job		OK
201
Job		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete job example-job
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job'
+
+
+

Output

+
+

+job "example-job" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a Job

+

HTTP Request

+

DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Job

+

HTTP Request

+

DELETE /apis/batch/v1/namespaces/{namespace}/jobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get job example-job -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job
+
+
+

Output

+
+

+{
+  "kind": "Job",
+  "apiVersion": "batch/v1",
+  "metadata": {
+    "name": "example-job",
+    "namespace": "default",
+    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+    "resourceVersion": "7482",
+    "creationTimestamp": "2016-11-04T18:45:25Z"
+  },
+  "spec": {
+    "parallelism": 1,
+    "completions": 1,
+    "selector": {
+      "matchLabels": {
+        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+      }
+    },
+    "template": {
+      "metadata": {
+        "name": "example-job",
+        "creationTimestamp": null,
+        "labels": {
+          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+          "job-name": "example-job"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "pi",
+            "image": "perl",
+            "command": [
+              "perl",
+              "-Mbignum=bpi",
+              "-wle",
+              "print bpi(2000)"
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "Always"
+          }
+        ],
+        "restartPolicy": "Never",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    }
+  },
+  "status": {
+    "startTime": "2016-11-04T18:45:25Z",
+    "active": 1
+  }
+}
+
+
+

Response Body

+
+

+{
+  "kind": "Job",
+  "apiVersion": "batch/v1",
+  "metadata": {
+    "name": "example-job",
+    "namespace": "default",
+    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+    "resourceVersion": "7482",
+    "creationTimestamp": "2016-11-04T18:45:25Z"
+  },
+  "spec": {
+    "parallelism": 1,
+    "completions": 1,
+    "selector": {
+      "matchLabels": {
+        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+      }
+    },
+    "template": {
+      "metadata": {
+        "name": "example-job",
+        "creationTimestamp": null,
+        "labels": {
+          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+          "job-name": "example-job"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "pi",
+            "image": "perl",
+            "command": [
+              "perl",
+              "-Mbignum=bpi",
+              "-wle",
+              "print bpi(2000)"
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "Always"
+          }
+        ],
+        "restartPolicy": "Never",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    }
+  },
+  "status": {
+    "startTime": "2016-11-04T18:45:25Z",
+    "active": 1
+  }
+}
+
+

read the specified Job

+

HTTP Request

+

GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Job		OK
+

List

+
+

kubectl Command

+
+

+$ kubectl get job -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs'
+
+
+

Output

+
+

+{
+  "kind": "JobList",
+  "apiVersion": "batch/v1",
+  "metadata": {
+    "selfLink": "/apis/batch/v1/namespaces/default/jobs",
+    "resourceVersion": "7589"
+  },
+  "items": [
+    {
+      "metadata": {
+        "name": "",
+        "namespace": "default",
+        "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
+        "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+        "resourceVersion": "7482",
+        "creationTimestamp": "2016-11-04T18:45:25Z"
+      },
+      "spec": {
+        "parallelism": 1,
+        "completions": 1,
+        "selector": {
+          "matchLabels": {
+            "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+          }
+        },
+        "template": {
+          "metadata": {
+            "name": "",
+            "creationTimestamp": null,
+            "labels": {
+              "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+              "job-name": ""
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "pi",
+                "image": "perl",
+                "command": [
+                  "perl",
+                  "-Mbignum=bpi",
+                  "-wle",
+                  "print bpi(2000)"
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Never",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        }
+      },
+      "status": {
+        "startTime": "2016-11-04T18:45:25Z",
+        "active": 1
+      }
+    }
+  ]
+}
+
+
+

Response Body

+
+

+{
+  "kind": "JobList",
+  "apiVersion": "batch/v1",
+  "metadata": {
+    "selfLink": "/apis/batch/v1/namespaces/default/jobs",
+    "resourceVersion": "7589"
+  },
+  "items": [
+    {
+      "metadata": {
+        "name": "",
+        "namespace": "default",
+        "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
+        "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+        "resourceVersion": "7482",
+        "creationTimestamp": "2016-11-04T18:45:25Z"
+      },
+      "spec": {
+        "parallelism": 1,
+        "completions": 1,
+        "selector": {
+          "matchLabels": {
+            "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+          }
+        },
+        "template": {
+          "metadata": {
+            "name": "",
+            "creationTimestamp": null,
+            "labels": {
+              "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+              "job-name": ""
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "pi",
+                "image": "perl",
+                "command": [
+                  "perl",
+                  "-Mbignum=bpi",
+                  "-wle",
+                  "print bpi(2000)"
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Never",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        }
+      },
+      "status": {
+        "startTime": "2016-11-04T18:45:25Z",
+        "active": 1
+      }
+    }
+  ]
+}
+
+

list or watch objects of kind Job

+

HTTP Request

+

GET /apis/batch/v1/namespaces/{namespace}/jobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
JobList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Job

+

HTTP Request

+

GET /apis/batch/v1/jobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
JobList		OK
+

Watch

+
+

kubectl Command

+
+

+$ kubectl get job example-job --watch -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/watch/namespaces/default/jobs/example-job'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Job",
+        "apiVersion": "batch/v1",
+        "metadata": {
+            "name": "example-job",
+            "namespace": "default",
+            "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+            "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+            "resourceVersion": "7482",
+            "creationTimestamp": "2016-11-04T18:45:25Z"
+        },
+        "spec": {
+            "parallelism": 1,
+            "completions": 1,
+            "selector": {
+                "matchLabels": {
+                    "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "name": "example-job",
+                    "creationTimestamp": null,
+                    "labels": {
+                        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+                        "job-name": "example-job"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "pi",
+                            "image": "perl",
+                            "command": [
+                                "perl",
+                                "-Mbignum=bpi",
+                                "-wle",
+                                "print bpi(2000)"
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "Always"
+                        }
+                    ],
+                    "restartPolicy": "Never",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            }
+        },
+        "status": {
+            "startTime": "2016-11-04T18:45:25Z",
+            "active": 1
+        }
+    }
+}
+
+
+

Response Body

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Job",
+        "apiVersion": "batch/v1",
+        "metadata": {
+            "name": "example-job",
+            "namespace": "default",
+            "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
+            "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+            "resourceVersion": "7482",
+            "creationTimestamp": "2016-11-04T18:45:25Z"
+        },
+        "spec": {
+            "parallelism": 1,
+            "completions": 1,
+            "selector": {
+                "matchLabels": {
+                    "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "name": "example-job",
+                    "creationTimestamp": null,
+                    "labels": {
+                        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
+                        "job-name": "example-job"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "pi",
+                            "image": "perl",
+                            "command": [
+                                "perl",
+                                "-Mbignum=bpi",
+                                "-wle",
+                                "print bpi(2000)"
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "Always"
+                        }
+                    ],
+                    "restartPolicy": "Never",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            }
+        },
+        "status": {
+            "startTime": "2016-11-04T18:45:25Z",
+            "active": 1
+        }
+    }
+}
+
+

watch changes to an object of kind Job

+

HTTP Request

+

GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Job

+

HTTP Request

+

GET /apis/batch/v1/watch/namespaces/{namespace}/jobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Job

+

HTTP Request

+

GET /apis/batch/v1/watch/jobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Job

+

HTTP Request

+

PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Job		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Job

+

HTTP Request

+

GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Job		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Job

+

HTTP Request

+

PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Job
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Job
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Job		OK
201
Job		Created
+
+

Pod v1 core

+
+

Pod Config to print "Hello World".

+
+

+apiVersion: v1
+kind: Pod
+metadata:
+  name: pod-example
+spec:
+  containers:
+  - name: ubuntu
+    image: ubuntu:trusty
+    command: ["echo"]
+    args: ["Hello World"]
+
+
+

Pod Config to print "Hello World".

+
+

+apiVersion: v1
+kind: Pod
+metadata:
+  name: pod-example
+spec:
+  containers:
+  - name: ubuntu
+    image: ubuntu:trusty
+    command: ["echo"]
+    args: ["Hello World"]
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Pod
+ + + + + + +

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PodSpec		Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
PodStatus		Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

PodSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
activeDeadlineSeconds
integer		Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
affinity
Affinity		If specified, the pod's scheduling constraints
automountServiceAccountToken
boolean		AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
containers
Container array
patch type: merge
patch merge key: name		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.
dnsConfig
PodDNSConfig		Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
dnsPolicy
string		Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
hostAliases
HostAlias array
patch type: merge
patch merge key: ip		HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
hostIPC
boolean		Use the host's ipc namespace. Optional: Default to false.
hostNetwork
boolean		Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
hostPID
boolean		Use the host's pid namespace. Optional: Default to false.
hostname
string		Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
imagePullSecrets
LocalObjectReference array
patch type: merge
patch merge key: name		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: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
initContainers
Container array
patch type: merge
patch merge key: name		List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
nodeName
string		NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
nodeSelector
object		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: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
priority
integer		The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
priorityClassName
string		If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
readinessGates
PodReadinessGate array		If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md
restartPolicy
string		Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
schedulerName
string		If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
securityContext
PodSecurityContext		SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
serviceAccount
string		DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
serviceAccountName
string		ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
shareProcessNamespace
boolean		Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. This field is alpha-level and is honored only by servers that enable the PodShareProcessNamespace feature.
subdomain
string		If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
terminationGracePeriodSeconds
integer		Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
tolerations
Toleration array		If specified, the pod's tolerations.
volumes
Volume array
patch type: merge,retainKeys
patch merge key: name		List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
+

PodStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
conditions
PodCondition array
patch type: merge
patch merge key: type		Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
containerStatuses
ContainerStatus array		The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
hostIP
string		IP address of the host to which the pod is assigned. Empty if not yet scheduled.
initContainerStatuses
ContainerStatus array		The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
message
string		A human readable message indicating details about why the pod is in this condition.
nominatedNodeName
string		nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
phase
string		The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
podIP
string		IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
qosClass
string		The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md
reason
string		A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'
startTime
Time		RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.
+

PodList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Pod array		List of pods. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Pod

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/pods

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Pod
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
Pod		Created
202
Pod		Accepted
200
Pod		OK
+

Create Eviction

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create eviction of a Pod

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/pods/{name}/eviction

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Eviction
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Eviction
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
Eviction		Created
202
Eviction		Accepted
200
Eviction		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Pod

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/pods/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Pod

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/pods/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Pod
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
201
Pod		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Pod

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/pods/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Pod

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/pods

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Pod

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/pods/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Pod

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/pods

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Pod

+

HTTP Request

+

GET /api/v1/pods

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Pod

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/pods/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Pod

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/pods

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Pod

+

HTTP Request

+

GET /api/v1/watch/pods

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Pod

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/pods/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Pod

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/pods/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Pod

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/pods/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Pod
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Pod		Created
200
Pod		OK
+

Proxy Operations

+

See supported operations below...

+

Create Connect Portforward

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to portforward of Pod

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/pods/{name}/portforward

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
portsList of ports to forward Required when using WebSockets
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Create Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Pod

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Create Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Pod

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Delete Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Pod

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Delete Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Pod

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Get Connect Portforward

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to portforward of Pod

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/pods/{name}/portforward

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
portsList of ports to forward Required when using WebSockets
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Get Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Pod

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Get Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Pod

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Head Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Pod

+

HTTP Request

+

HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Head Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Pod

+

HTTP Request

+

HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Replace Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Pod

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Replace Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Pod

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to pod.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Misc Operations

+

See supported operations below...

+

Read Log

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read log of the specified Pod

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/pods/{name}/log

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
containerThe container for which to stream logs. Defaults to only container if there is one container in the pod.
followFollow the log stream of the pod. Defaults to false.
limitBytesIf set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
prettyIf 'true', then the output is pretty printed.
previousReturn previous terminated container logs. Defaults to false.
sinceSecondsA relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
tailLinesIf set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
timestampsIf true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+
+

ReplicaSet v1 apps

+
+

ReplicaSet Config to run 3 nginx instances.

+
+

+apiVersion: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+  # Unique key of the ReplicaSet instance
+  name: replicaset-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      # Run the nginx image
+      - name: nginx
+        image: nginx:1.10
+
+
+

ReplicaSet Config to run 3 nginx instances.

+
+

+apiVersion: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+  # Unique key of the ReplicaSet instance
+  name: replicaset-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      # Run the nginx image
+      - name: nginx
+        image: nginx:1.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1ReplicaSet
+ + + + + + +

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ReplicaSetSpec		Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
ReplicaSetStatus		Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

ReplicaSetSpec v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer		Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
selector
LabelSelector		Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
+

ReplicaSetStatus v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		The number of available replicas (ready for at least minReadySeconds) for this replica set.
conditions
ReplicaSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a replica set's current state.
fullyLabeledReplicas
integer		The number of pods that have labels matching the labels of the pod template of the replicaset.
observedGeneration
integer		ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
readyReplicas
integer		The number of ready replicas for this replica set.
replicas
integer		Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
+

ReplicaSetList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ReplicaSet array		List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ReplicaSet

+

HTTP Request

+

POST /apis/apps/v1/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
201
ReplicaSet		Created
202
ReplicaSet		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
201
ReplicaSet		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ReplicaSet

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ReplicaSet

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/watch/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
201
ReplicaSet		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

ReplicationController v1 core

+
+

ReplicationController Config to run 3 nginx instances.

+
+

+apiVersion: v1
+kind: ReplicationController
+metadata:
+  # Unique key of the ReplicationController instance
+  name: replicationcontroller-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      # Run the nginx image
+      - name: nginx
+        image: nginx:1.10
+
+
+

ReplicationController Config to run 3 nginx instances.

+
+

+apiVersion: v1
+kind: ReplicationController
+metadata:
+  # Unique key of the ReplicationController instance
+  name: replicationcontroller-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      # Run the nginx image
+      - name: nginx
+        image: nginx:1.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ReplicationController
+ + + + + + +

ReplicationController represents the configuration of a replication controller.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ReplicationControllerSpec		Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
ReplicationControllerStatus		Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

ReplicationControllerSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer		Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
selector
object		Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
+

ReplicationControllerStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		The number of available replicas (ready for at least minReadySeconds) for this replication controller.
conditions
ReplicationControllerCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a replication controller's current state.
fullyLabeledReplicas
integer		The number of pods that have labels matching the labels of the pod template of the replication controller.
observedGeneration
integer		ObservedGeneration reflects the generation of the most recently observed replication controller.
readyReplicas
integer		The number of ready replicas for this replication controller.
replicas
integer		Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
+

ReplicationControllerList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ReplicationController array		List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ReplicationController

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/replicationcontrollers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicationController
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
201
ReplicationController		Created
202
ReplicationController		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ReplicationController

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ReplicationController

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicationController
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
201
ReplicationController		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ReplicationController

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ReplicationController

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/replicationcontrollers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ReplicationController

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicationController

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/replicationcontrollers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationControllerList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicationController

+

HTTP Request

+

GET /api/v1/replicationcontrollers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationControllerList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicationController

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicationController

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicationController

+

HTTP Request

+

GET /api/v1/watch/replicationcontrollers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified ReplicationController

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified ReplicationController

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified ReplicationController

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicationController
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
201
ReplicationController		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified ReplicationController

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified ReplicationController

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified ReplicationController

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

StatefulSet v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1StatefulSet
+ + + +

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

+
    +
  • Network: A single stable DNS and hostname.
    • +
  • Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity.
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
StatefulSetSpec		Spec defines the desired identities of pods in this set.
status
StatefulSetStatus		Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+

StatefulSetSpec v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string		podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer		replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer		revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector		selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
serviceName
string		serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec		template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy
StatefulSetUpdateStrategy		updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
volumeClaimTemplates
PersistentVolumeClaim array		volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+

StatefulSetStatus v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer		collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
StatefulSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a statefulset's current state.
currentReplicas
integer		currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
currentRevision
string		currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
observedGeneration
integer		observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
readyReplicas
integer		readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
replicas
integer		replicas is the number of Pods created by the StatefulSet controller.
updateRevision
string		updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
updatedReplicas
integer		updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
+

StatefulSetList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
StatefulSet array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StatefulSet

+

HTTP Request

+

POST /apis/apps/v1/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
StatefulSet		Created
202
StatefulSet		Accepted
200
StatefulSet		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/watch/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

DISCOVERY & LOAD BALANCING

+

Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, +Workloads are only accessible within the cluster, and they must be exposed externally using a either +a LoadBalancer or NodePort Service. For development, internally accessible +Workloads can be accessed via proxy through the api master using the kubectl proxy command.

+

Common resource types:

+
    +
  • Services for providing a single ip endpoint loadbalanced across multiple Workload replicas.
    • +
  • Ingress for providing a https(s) endpoint http(s) routed to one or more Services
    • +
+
+
+

Endpoints v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Endpoints
+

Endpoints is a collection of endpoints that implement the actual service. Example: + Name: "mysvc", + Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, + ]

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
subsets
EndpointSubset array		The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.
+

EndpointsList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Endpoints array		List of endpoints.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create Endpoints

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/endpoints

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Endpoints
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Endpoints		OK
201
Endpoints		Created
202
Endpoints		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Endpoints

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/endpoints/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Endpoints
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Endpoints		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Endpoints

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/endpoints/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Endpoints
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Endpoints
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Endpoints		OK
201
Endpoints		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete Endpoints

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/endpoints/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Endpoints
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Endpoints

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/endpoints

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Endpoints

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/endpoints/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Endpoints
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Endpoints		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Endpoints

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/endpoints

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
EndpointsList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Endpoints

+

HTTP Request

+

GET /api/v1/endpoints

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
EndpointsList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Endpoints

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Endpoints
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Endpoints

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/endpoints

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Endpoints

+

HTTP Request

+

GET /api/v1/watch/endpoints

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

Ingress v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1Ingress
+

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
IngressSpec		Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
IngressStatus		Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

IngressSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
backend
IngressBackend		A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
rules
IngressRule array		A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
tls
IngressTLS array		TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
+

IngressStatus v1beta1 extensions

+ + + + + + + + + + + + + + + +
FieldDescription
loadBalancer
LoadBalancerStatus		LoadBalancer contains the current status of the load-balancer.
+

IngressList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Ingress array		Items is the list of Ingress.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an Ingress

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Ingress
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
201
Ingress		Created
202
Ingress		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Ingress

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Ingress

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Ingress
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
201
Ingress		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an Ingress

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Ingress

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
IngressList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/ingresses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
IngressList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/ingresses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Ingress

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Ingress

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Ingress
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Ingress		Created
200
Ingress		OK
+
+

Service v1 core

+
+

Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.

+
+

+kind: Service
+apiVersion: v1
+metadata:
+  # Unique key of the Service instance
+  name: service-example
+spec:
+  ports:
+    # Accept traffic sent to port 80
+    - name: http
+      port: 80
+      targetPort: 80
+  selector:
+    # Loadbalance traffic across Pods matching
+    # this label selector
+    app: nginx
+  # Create an HA proxy in the cloud provider
+  # with an External IP address - *Only supported
+  # by some cloud providers*
+  type: LoadBalancer
+
+
+

Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.

+
+

+kind: Service
+apiVersion: v1
+metadata:
+  # Unique key of the Service instance
+  name: service-example
+spec:
+  ports:
+    # Accept traffic sent to port 80
+    - name: http
+      port: 80
+      targetPort: 80
+  selector:
+    # Loadbalance traffic across Pods matching
+    # this label selector
+    app: nginx
+  # Create an HA proxy in the cloud provider
+  # with an External IP address - *Only supported
+  # by some cloud providers*
+  type: LoadBalancer
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Service
+

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ServiceSpec		Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
ServiceStatus		Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

ServiceSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
clusterIP
string		clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
externalIPs
string array		externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.
externalName
string		externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.
externalTrafficPolicy
string		externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
healthCheckNodePort
integer		healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.
loadBalancerIP
string		Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
loadBalancerSourceRanges
string array		If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
ports
ServicePort array
patch type: merge
patch merge key: port		The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
publishNotReadyAddresses
boolean		publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery.
selector
object		Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/
sessionAffinity
string		Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
sessionAffinityConfig
SessionAffinityConfig		sessionAffinityConfig contains the configurations of session affinity.
type
string		type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types
+

ServiceStatus v1 core

+ + + + + + + + + + + + + + + +
FieldDescription
loadBalancer
LoadBalancerStatus		LoadBalancer contains the current status of the load-balancer, if one is present.
+

ServiceList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Service array		List of services
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'kind: Service
+apiVersion: v1
+metadata:
+  name: service-example
+spec:
+  ports:
+    - name: http
+      port: 80
+      targetPort: 80
+  selector:
+      app: nginx
+  type: LoadBalancer
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+kind: Service
+apiVersion: v1
+metadata:
+  name: service-example
+spec:
+  ports:
+    - name: http
+      port: 80
+      targetPort: 80
+  selector:
+      app: nginx
+  type: LoadBalancer
+' http://127.0.0.1:8001/api/v1/namespaces/default/services
+
+
+

Output

+
+

+service "service-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "service-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/service-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2205767",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 80,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {}
+  }
+}
+
+

create a Service

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/services

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Service
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Service		OK
201
Service		Created
202
Service		Accepted
+

Patch

+
+

kubectl Command

+
+

+$ kubectl patch service  -p \
+    '{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}'
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}' \
+    'http://127.0.0.1:8001/api/v1/namespaces/default/services/'
+
+
+

Output

+
+

+"" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2205995",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 8080,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {
+      "ingress": [
+        {
+          "ip": "104.198.186.106"
+        }
+      ]
+    }
+  }
+}
+
+

partially update the specified Service

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/services/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: v1
+kind: Service
+metadata:
+  name: deployment-example
+  resourceVersion: "2205995"
+spec:
+  clusterIP: 10.183.250.161
+  ports:
+  - name: http
+    nodePort: 32417
+    port: 80
+    protocol: TCP
+    targetPort: 8080
+  selector:
+    app: nginx
+  sessionAffinity: None
+  type: LoadBalancer
+' | kubectl replace -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: v1
+kind: Service
+metadata:
+  name: deployment-example
+  resourceVersion: "2205995"
+spec:
+  clusterIP: 10.183.250.161
+  ports:
+  - name: http
+    nodePort: 32417
+    port: 80
+    protocol: TCP
+    targetPort: 8080
+  selector:
+    app: nginx
+  sessionAffinity: None
+  type: LoadBalancer
+' http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+
+

Output

+
+

+service "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2208672",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 8080,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {
+      "ingress": [
+        {
+          "ip": "104.198.186.106"
+        }
+      ]
+    }
+  }
+}
+
+

replace the specified Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Service
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Service		OK
201
Service		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete service deployment-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example'
+
+
+

Output

+
+

+service "deployment-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a Service

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/services/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get service deployment-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2205995",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 8080,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {
+      "ingress": [
+        {
+          "ip": "104.198.186.106"
+        }
+      ]
+    }
+  }
+}
+
+
+

Response Body

+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2205995",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 8080,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {
+      "ingress": [
+        {
+          "ip": "104.198.186.106"
+        }
+      ]
+    }
+  }
+}
+
+

read the specified Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

List

+
+

kubectl Command

+
+

+$ kubectl get service -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/api/v1/namespaces/default/services'
+
+
+

Output

+
+

+
+
+

Response Body

+
+

+
+

list or watch objects of kind Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Service

+

HTTP Request

+

GET /api/v1/services

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceList		OK
+

Watch

+
+

kubectl Command

+
+

+$ kubectl get service deployment-example --watch -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/api/v1/watch/namespaces/default/services/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Service",
+        "apiVersion": "v1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+            "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+            "resourceVersion": "2205995",
+            "creationTimestamp": "2016-10-28T17:04:24Z"
+        },
+        "spec": {
+            "ports": [
+                {
+                    "name": "http",
+                    "protocol": "TCP",
+                    "port": 80,
+                    "targetPort": 8080,
+                    "nodePort": 32417
+                }
+            ],
+            "selector": {
+                "app": "nginx"
+            },
+            "clusterIP": "10.183.250.161",
+            "type": "LoadBalancer",
+            "sessionAffinity": "None"
+        },
+        "status": {
+            "loadBalancer": {
+                "ingress": [
+                    {
+                        "ip": "104.198.186.106"
+                    }
+                ]
+            }
+        }
+    }
+}
+
+
+

Response Body

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Service",
+        "apiVersion": "v1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+            "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+            "resourceVersion": "2205995",
+            "creationTimestamp": "2016-10-28T17:04:24Z"
+        },
+        "spec": {
+            "ports": [
+                {
+                    "name": "http",
+                    "protocol": "TCP",
+                    "port": 80,
+                    "targetPort": 8080,
+                    "nodePort": 32417
+                }
+            ],
+            "selector": {
+                "app": "nginx"
+            },
+            "clusterIP": "10.183.250.161",
+            "type": "LoadBalancer",
+            "sessionAffinity": "None"
+        },
+        "status": {
+            "loadBalancer": {
+                "ingress": [
+                    {
+                        "ip": "104.198.186.106"
+                    }
+                ]
+            }
+        }
+    }
+}
+
+

watch changes to an object of kind Service

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/services/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Service

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/services

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Service

+

HTTP Request

+

GET /api/v1/watch/services

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Service

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/services/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Service
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Service		Created
200
Service		OK
+

Proxy Operations

+

See supported operations below...

+

Create Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Service

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Create Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Service

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Delete Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Service

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Delete Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Service

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Get Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Get Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Head Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Service

+

HTTP Request

+

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Head Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Service

+

HTTP Request

+

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Replace Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Replace Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

CONFIG & STORAGE

+

Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.

+

Common resource types:

+
    +
  • ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
    • +
  • Secrets for providing binary data injected into the application through files
    • +
  • Volumes for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.
    • +
+
+
+

ConfigMap v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ConfigMap
+

ConfigMap holds configuration data for pods to consume.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
binaryData
object		BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
data
object		Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

ConfigMapList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ConfigMap array		Items is the list of ConfigMaps.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ConfigMap

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/configmaps

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ConfigMap
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
ConfigMap		Accepted
200
ConfigMap		OK
201
ConfigMap		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ConfigMap

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/configmaps/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ConfigMap
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ConfigMap		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ConfigMap

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/configmaps/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ConfigMap
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ConfigMap
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ConfigMap		OK
201
ConfigMap		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ConfigMap

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/configmaps/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ConfigMap
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ConfigMap

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/configmaps

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ConfigMap

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/configmaps/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ConfigMap
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ConfigMap		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ConfigMap

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/configmaps

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ConfigMapList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ConfigMap

+

HTTP Request

+

GET /api/v1/configmaps

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ConfigMapList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ConfigMap

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ConfigMap
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ConfigMap

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/configmaps

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ConfigMap

+

HTTP Request

+

GET /api/v1/watch/configmaps

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

Secret v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Secret
+

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
data
object		Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
stringData
object		stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
type
string		Used to facilitate programmatic handling of secret data.
+

SecretList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Secret array		Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Secret

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/secrets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Secret
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
Secret		Created
202
Secret		Accepted
200
Secret		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Secret

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/secrets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Secret
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Secret		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Secret

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/secrets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Secret
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Secret
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Secret		OK
201
Secret		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Secret

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/secrets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Secret
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Secret

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/secrets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Secret

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/secrets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Secret
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Secret		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Secret

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/secrets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
SecretList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Secret

+

HTTP Request

+

GET /api/v1/secrets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
SecretList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Secret

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/secrets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Secret
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Secret

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/secrets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Secret

+

HTTP Request

+

GET /api/v1/watch/secrets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PersistentVolumeClaim v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PersistentVolumeClaim
+ + + + + +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PersistentVolumeClaimSpec		Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
status
PersistentVolumeClaimStatus		Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+

PersistentVolumeClaimSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
accessModes
string array		AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
resources
ResourceRequirements		Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector
LabelSelector		A label query over volumes to consider for binding.
storageClassName
string		Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode
string		volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.
volumeName
string		VolumeName is the binding reference to the PersistentVolume backing this claim.
+

PersistentVolumeClaimStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
accessModes
string array		AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
capacity
object		Represents the actual resources of the underlying volume.
conditions
PersistentVolumeClaimCondition array
patch type: merge
patch merge key: type		Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
phase
string		Phase represents the current phase of PersistentVolumeClaim.
+

PersistentVolumeClaimList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PersistentVolumeClaim array		A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PersistentVolumeClaim

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/persistentvolumeclaims

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
201
PersistentVolumeClaim		Created
202
PersistentVolumeClaim		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PersistentVolumeClaim

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PersistentVolumeClaim

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
201
PersistentVolumeClaim		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PersistentVolumeClaim

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PersistentVolumeClaim

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaimList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/persistentvolumeclaims

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaimList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/watch/persistentvolumeclaims

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified PersistentVolumeClaim

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified PersistentVolumeClaim

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolumeClaim
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
201
PersistentVolumeClaim		Created
+
+

StorageClass v1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1StorageClass
+ + + +

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

+

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowVolumeExpansion
boolean		AllowVolumeExpansion shows whether the storage class allow volume expand
allowedTopologies
TopologySelectorTerm array		Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is alpha-level and is only honored by servers that enable the DynamicProvisioningScheduling feature.
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
mountOptions
string array		Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
parameters
object		Parameters holds the parameters for the provisioner that should create volumes of this storage class.
provisioner
string		Provisioner indicates the type of the provisioner.
reclaimPolicy
string		Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
volumeBindingMode
string		VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
+

StorageClassList v1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
StorageClass array		Items is the list of StorageClasses
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StorageClass

+

HTTP Request

+

POST /apis/storage.k8s.io/v1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
201
StorageClass		Created
202
StorageClass		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StorageClass

+

HTTP Request

+

PATCH /apis/storage.k8s.io/v1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StorageClass

+

HTTP Request

+

PUT /apis/storage.k8s.io/v1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
201
StorageClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StorageClass

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StorageClass

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClassList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1/watch/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

Volume v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Volume
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
awsElasticBlockStore
AWSElasticBlockStoreVolumeSource		AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDisk
AzureDiskVolumeSource		AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile
AzureFileVolumeSource		AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
cephfs
CephFSVolumeSource		CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder
CinderVolumeSource		Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
configMap
ConfigMapVolumeSource		ConfigMap represents a configMap that should populate this volume
downwardAPI
DownwardAPIVolumeSource		DownwardAPI represents downward API about the pod that should populate this volume
emptyDir
EmptyDirVolumeSource		EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
fc
FCVolumeSource		FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume
FlexVolumeSource		FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
flocker
FlockerVolumeSource		Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
gcePersistentDisk
GCEPersistentDiskVolumeSource		GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
gitRepo
GitRepoVolumeSource		GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
glusterfs
GlusterfsVolumeSource		Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath
HostPathVolumeSource		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: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
iscsi
ISCSIVolumeSource		ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md
name
string		Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
nfs
NFSVolumeSource		NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
persistentVolumeClaim
PersistentVolumeClaimVolumeSource		PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
photonPersistentDisk
PhotonPersistentDiskVolumeSource		PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
portworxVolume
PortworxVolumeSource		PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
projected
ProjectedVolumeSource		Items for all in one resources secrets, configmaps, and downward API
quobyte
QuobyteVolumeSource		Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd
RBDVolumeSource		RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
scaleIO
ScaleIOVolumeSource		ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
secret
SecretVolumeSource		Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
storageos
StorageOSVolumeSource		StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
vsphereVolume
VsphereVirtualDiskVolumeSource		VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+
+

VolumeAttachment v1beta1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1VolumeAttachment
+ + + +

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

+

VolumeAttachment objects are non-namespaced.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
VolumeAttachmentSpec		Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
status
VolumeAttachmentStatus		Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
+

VolumeAttachmentSpec v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attacher
string		Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
nodeName
string		The node that the volume should be attached to.
source
VolumeAttachmentSource		Source represents the volume that should be attached.
+

VolumeAttachmentStatus v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attachError
VolumeError		The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attached
boolean		Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attachmentMetadata
object		Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
detachError
VolumeError		The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
+

VolumeAttachmentList v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
VolumeAttachment array		Items is the list of VolumeAttachments
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a VolumeAttachment

+

HTTP Request

+

POST /apis/storage.k8s.io/v1beta1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
201
VolumeAttachment		Created
202
VolumeAttachment		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified VolumeAttachment

+

HTTP Request

+

PATCH /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified VolumeAttachment

+

HTTP Request

+

PUT /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
201
VolumeAttachment		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachmentList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

METADATA

+

Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.

+

Common resource types:

+
    +
  • HorizontalPodAutoscaler (HPA) for automatically scaling the replicacount of your workloads in response to load
    • +
  • PodDisruptionBudget for configuring how many replicas in a given workload maybe made concurrently unavailable when performing maintenance.
    • +
  • ThirdPartyResource for extending the Kubernetes APIs with your own types
    • +
  • Event for notification of resource lifecycle events in the cluster.
    • +
+
+
+

ControllerRevision v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1ControllerRevision
+ + + +

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
dataData is the serialized representation of the state.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
revision
integer		Revision indicates the revision of the state represented by Data.
+

ControllerRevisionList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ControllerRevision array		Items is the list of ControllerRevisions
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ControllerRevision

+

HTTP Request

+

POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
201
ControllerRevision		Created
202
ControllerRevision		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ControllerRevision

+

HTTP Request

+

PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ControllerRevision

+

HTTP Request

+

PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ControllerRevision		Created
200
ControllerRevision		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevisionList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevisionList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/watch/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

CustomResourceDefinition v1beta1 apiextensions.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinition
+

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
CustomResourceDefinitionSpec		Spec describes how the user wants the resources to appear
status
CustomResourceDefinitionStatus		Status indicates the actual state of the CustomResourceDefinition
+

CustomResourceDefinitionSpec v1beta1 apiextensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
additionalPrinterColumns
CustomResourceColumnDefinition array		AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column.
group
string		Group is the group this resource belongs in
names
CustomResourceDefinitionNames		Names are the names used to describe this custom resource
scope
string		Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced
subresources
CustomResourceSubresources		Subresources describes the subresources for CustomResources
validation
CustomResourceValidation		Validation describes the validation methods for CustomResources
version
string		Version is the version this resource belongs in Should be always first item in Versions field if provided. Optional, but at least one of Version or Versions must be set. Deprecated: Please use Versions.
versions
CustomResourceDefinitionVersion array		Versions is the list of all supported versions for this resource. If Version field is provided, this field is optional. Validation: All versions must use the same validation schema for now. i.e., top level Validation field is applied to all of these versions. Order: The version name will be used to compute the order. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
+

CustomResourceDefinitionStatus v1beta1 apiextensions

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
acceptedNames
CustomResourceDefinitionNames		AcceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec.
conditions
CustomResourceDefinitionCondition array		Conditions indicate state for particular aspects of a CustomResourceDefinition
storedVersions
string array		StoredVersions are all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so the migration controller can first finish a migration to another version (i.e. that no old objects are left in the storage), and then remove the rest of the versions from this list. None of the versions in this list can be removed from the spec.Versions field.
+

CustomResourceDefinitionList v1beta1 apiextensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
CustomResourceDefinition array		Items individual CustomResourceDefinitions
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a CustomResourceDefinition

+

HTTP Request

+

POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
CustomResourceDefinition		Created
202
CustomResourceDefinition		Accepted
200
CustomResourceDefinition		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified CustomResourceDefinition

+

HTTP Request

+

PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified CustomResourceDefinition

+

HTTP Request

+

PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
CustomResourceDefinition		Created
200
CustomResourceDefinition		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a CustomResourceDefinition

+

HTTP Request

+

DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of CustomResourceDefinition

+

HTTP Request

+

DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinitionList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified CustomResourceDefinition

+

HTTP Request

+

PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified CustomResourceDefinition

+

HTTP Request

+

PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
201
CustomResourceDefinition		Created
+
+

Event v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Event
+ + + +

Event is a report of an event somewhere in the cluster.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
action
string		What action was taken/failed regarding to the Regarding object.
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
count
integer		The number of times this event has occurred.
eventTime
MicroTime		Time when this Event was first observed.
firstTimestamp
Time		The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
involvedObject
ObjectReference		The object that this event is about.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
lastTimestamp
Time		The time at which the most recent occurrence of this event was recorded.
message
string		A human-readable description of the status of this operation.
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
reason
string		This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
related
ObjectReference		Optional secondary object for more complex actions.
reportingComponent
string		Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
reportingInstance
string		ID of the controller instance, e.g. kubelet-xyzf.
series
EventSeries		Data about the Event series this event represents or nil if it's a singleton Event.
source
EventSource		The component reporting this event. Should be a short machine understandable string.
type
string		Type of this event (Normal, Warning), new types could be added in the future
+

EventList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Event array		List of events
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an Event

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
Event		Accepted
200
Event		OK
201
Event		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Event

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Event

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Event		Created
200
Event		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an Event

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Event

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Event

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Event

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
EventList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Event

+

HTTP Request

+

GET /api/v1/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
EventList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Event

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

HTTP Request

+

GET /api/v1/watch/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

LimitRange v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1LimitRange
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
LimitRangeSpec		Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

LimitRangeSpec v1 core

+ + + + + + + + + + + + + + + +
FieldDescription
limits
LimitRangeItem array		Limits is the list of LimitRangeItem objects that are enforced.
+

LimitRangeList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
LimitRange array		Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a LimitRange

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/limitranges

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
LimitRange
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
LimitRange		OK
201
LimitRange		Created
202
LimitRange		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified LimitRange

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/limitranges/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the LimitRange
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
LimitRange		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified LimitRange

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/limitranges/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the LimitRange
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
LimitRange
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
LimitRange		OK
201
LimitRange		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a LimitRange

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/limitranges/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the LimitRange
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of LimitRange

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/limitranges

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified LimitRange

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/limitranges/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the LimitRange
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
LimitRange		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind LimitRange

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/limitranges

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
LimitRangeList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind LimitRange

+

HTTP Request

+

GET /api/v1/limitranges

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
LimitRangeList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind LimitRange

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the LimitRange
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of LimitRange

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/limitranges

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of LimitRange

+

HTTP Request

+

GET /api/v1/watch/limitranges

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

HorizontalPodAutoscaler v1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv1HorizontalPodAutoscaler
+ + + +

configuration of a horizontal pod autoscaler.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
HorizontalPodAutoscalerSpec		behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
HorizontalPodAutoscalerStatus		current information about the autoscaler.
+

HorizontalPodAutoscalerSpec v1 autoscaling

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
maxReplicas
integer		upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
minReplicas
integer		lower limit for the number of pods that can be set by the autoscaler, default 1.
scaleTargetRef
CrossVersionObjectReference		reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
targetCPUUtilizationPercentage
integer		target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
+

HorizontalPodAutoscalerStatus v1 autoscaling

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
currentCPUUtilizationPercentage
integer		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.
currentReplicas
integer		current number of replicas of pods managed by this autoscaler.
desiredReplicas
integer		desired number of replicas of pods managed by this autoscaler.
lastScaleTime
Time		last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
observedGeneration
integer		most recent generation observed by this autoscaler.
+

HorizontalPodAutoscalerList v1 autoscaling

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
HorizontalPodAutoscaler array		list of horizontal pod autoscaler objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a HorizontalPodAutoscaler

+

HTTP Request

+

POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
HorizontalPodAutoscaler		Created
202
HorizontalPodAutoscaler		Accepted
200
HorizontalPodAutoscaler		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified HorizontalPodAutoscaler

+

HTTP Request

+

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified HorizontalPodAutoscaler

+

HTTP Request

+

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
201
HorizontalPodAutoscaler		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a HorizontalPodAutoscaler

+

HTTP Request

+

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of HorizontalPodAutoscaler

+

HTTP Request

+

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscalerList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscalerList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/watch/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified HorizontalPodAutoscaler

+

HTTP Request

+

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified HorizontalPodAutoscaler

+

HTTP Request

+

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
201
HorizontalPodAutoscaler		Created
+
+

InitializerConfiguration v1alpha1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1alpha1InitializerConfiguration
+

InitializerConfiguration describes the configuration of initializers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
initializers
Initializer array
patch type: merge
patch merge key: name		Initializers is a list of resources and their default initializers Order-sensitive. When merging multiple InitializerConfigurations, we sort the initializers from different InitializerConfigurations by the name of the InitializerConfigurations; the order of the initializers from the same InitializerConfiguration is preserved.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
+

InitializerConfigurationList v1alpha1 admissionregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
InitializerConfiguration array		List of InitializerConfiguration.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an InitializerConfiguration

+

HTTP Request

+

POST /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
InitializerConfiguration
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
InitializerConfiguration		OK
201
InitializerConfiguration		Created
202
InitializerConfiguration		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified InitializerConfiguration

+

HTTP Request

+

PATCH /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
InitializerConfiguration		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified InitializerConfiguration

+

HTTP Request

+

PUT /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
InitializerConfiguration
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
InitializerConfiguration		Created
200
InitializerConfiguration		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an InitializerConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of InitializerConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
InitializerConfiguration		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
InitializerConfigurationList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

MutatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1MutatingWebhookConfiguration
+

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
webhooks
Webhook array
patch type: merge
patch merge key: name		Webhooks is a list of webhooks and the affected resources and operations.
+

MutatingWebhookConfigurationList v1beta1 admissionregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
MutatingWebhookConfiguration array		List of MutatingWebhookConfiguration.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a MutatingWebhookConfiguration

+

HTTP Request

+

POST /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
MutatingWebhookConfiguration
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfiguration		OK
201
MutatingWebhookConfiguration		Created
202
MutatingWebhookConfiguration		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified MutatingWebhookConfiguration

+

HTTP Request

+

PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfiguration		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified MutatingWebhookConfiguration

+

HTTP Request

+

PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
MutatingWebhookConfiguration
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfiguration		OK
201
MutatingWebhookConfiguration		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a MutatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of MutatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfiguration		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfigurationList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ValidatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1ValidatingWebhookConfiguration
+

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
webhooks
Webhook array
patch type: merge
patch merge key: name		Webhooks is a list of webhooks and the affected resources and operations.
+

ValidatingWebhookConfigurationList v1beta1 admissionregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ValidatingWebhookConfiguration array		List of ValidatingWebhookConfiguration.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ValidatingWebhookConfiguration

+

HTTP Request

+

POST /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ValidatingWebhookConfiguration
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration		OK
201
ValidatingWebhookConfiguration		Created
202
ValidatingWebhookConfiguration		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ValidatingWebhookConfiguration

+

HTTP Request

+

PATCH /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ValidatingWebhookConfiguration

+

HTTP Request

+

PUT /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ValidatingWebhookConfiguration
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration		OK
201
ValidatingWebhookConfiguration		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ValidatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ValidatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfigurationList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PodTemplate v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodTemplate
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
template
PodTemplateSpec		Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

PodTemplateSpec v1 core

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PodSpec		Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

PodTemplateList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PodTemplate array		List of pod templates
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodTemplate

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/podtemplates

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodTemplate
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
PodTemplate		OK
201
PodTemplate		Created
202
PodTemplate		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PodTemplate

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodTemplate		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PodTemplate

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/podtemplates/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodTemplate
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodTemplate		OK
201
PodTemplate		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PodTemplate

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PodTemplate

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/podtemplates

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PodTemplate

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/podtemplates/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodTemplate		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodTemplate

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/podtemplates

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodTemplateList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodTemplate

+

HTTP Request

+

GET /api/v1/podtemplates

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodTemplateList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodTemplate

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodTemplate

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/podtemplates

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodTemplate

+

HTTP Request

+

GET /api/v1/watch/podtemplates

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PodDisruptionBudget v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1PodDisruptionBudget
+

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
PodDisruptionBudgetSpec		Specification of the desired behavior of the PodDisruptionBudget.
status
PodDisruptionBudgetStatus		Most recently observed status of the PodDisruptionBudget.
+

PodDisruptionBudgetSpec v1beta1 policy

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
maxUnavailableAn eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
minAvailableAn eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector
LabelSelector		Label query over pods whose evictions are managed by the disruption budget.
+

PodDisruptionBudgetStatus v1beta1 policy

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
currentHealthy
integer		current number of healthy pods
desiredHealthy
integer		minimum desired number of healthy pods
disruptedPods
object		DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
disruptionsAllowed
integer		Number of pod disruptions that are currently allowed.
expectedPods
integer		total number of pods counted by this disruption budget
observedGeneration
integer		Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation.
+

PodDisruptionBudgetList v1beta1 policy

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PodDisruptionBudget array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodDisruptionBudget

+

HTTP Request

+

POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
201
PodDisruptionBudget		Created
202
PodDisruptionBudget		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PodDisruptionBudget

+

HTTP Request

+

PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PodDisruptionBudget

+

HTTP Request

+

PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
201
PodDisruptionBudget		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PodDisruptionBudget

+

HTTP Request

+

DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PodDisruptionBudget

+

HTTP Request

+

DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudgetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/poddisruptionbudgets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudgetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/poddisruptionbudgets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified PodDisruptionBudget

+

HTTP Request

+

PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified PodDisruptionBudget

+

HTTP Request

+

PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
201
PodDisruptionBudget		Created
+
+

PriorityClass v1beta1 scheduling.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
scheduling.k8s.iov1beta1PriorityClass
+ + + + + + +

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
description
string		description is an arbitrary string that usually provides guidelines on when this priority class should be used.
globalDefault
boolean		globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as globalDefault. However, if more than one PriorityClasses exists with their globalDefault field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
value
integer		The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
+

PriorityClassList v1beta1 scheduling

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PriorityClass array		items is the list of PriorityClasses
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PriorityClass

+

HTTP Request

+

POST /apis/scheduling.k8s.io/v1beta1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
PriorityClass		Created
202
PriorityClass		Accepted
200
PriorityClass		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PriorityClass

+

HTTP Request

+

PATCH /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PriorityClass

+

HTTP Request

+

PUT /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
201
PriorityClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClassList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PodPreset v1alpha1 settings.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
settings.k8s.iov1alpha1PodPreset
+ + + + + + +

PodPreset is a policy resource that defines additional runtime requirements for a Pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
PodPresetSpec
+

PodPresetSpec v1alpha1 settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
env
EnvVar array		Env defines the collection of EnvVar to inject into containers.
envFrom
EnvFromSource array		EnvFrom defines the collection of EnvFromSource to inject into containers.
selector
LabelSelector		Selector is a label query over a set of resources, in this case pods. Required.
volumeMounts
VolumeMount array		VolumeMounts defines the collection of VolumeMount to inject into containers.
volumes
Volume array		Volumes defines the collection of Volume to inject into the pod.
+

PodPresetList v1alpha1 settings

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PodPreset array		Items is a list of schema objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodPreset

+

HTTP Request

+

POST /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodPreset
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
PodPreset		OK
201
PodPreset		Created
202
PodPreset		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PodPreset

+

HTTP Request

+

PATCH /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodPreset
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPreset		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PodPreset

+

HTTP Request

+

PUT /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodPreset
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodPreset
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodPreset		OK
201
PodPreset		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PodPreset

+

HTTP Request

+

DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodPreset
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PodPreset

+

HTTP Request

+

DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodPreset
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPreset		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPresetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/podpresets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPresetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the PodPreset
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/watch/podpresets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PodSecurityPolicy v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1PodSecurityPolicy
+

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated: use PodSecurityPolicy from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PodSecurityPolicySpec		spec defines the policy enforced.
+

PodSecurityPolicySpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowPrivilegeEscalation
boolean		allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
allowedCapabilities
string array		allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities.
allowedFlexVolumes
AllowedFlexVolume array		allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field.
allowedHostPaths
AllowedHostPath array		allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used.
allowedUnsafeSysctls
string array		allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of allowed sysctls. Single means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/" allows "foo/bar", "foo/baz", etc. e.g. "foo." allows "foo.bar", "foo.baz", etc.
defaultAddCapabilities
string array		defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list.
defaultAllowPrivilegeEscalation
boolean		defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
forbiddenSysctls
string array		forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of forbidden sysctls. Single means all sysctls are forbidden. Examples: e.g. "foo/" forbids "foo/bar", "foo/baz", etc. e.g. "foo." forbids "foo.bar", "foo.baz", etc.
fsGroup
FSGroupStrategyOptions		fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.
hostIPC
boolean		hostIPC determines if the policy allows the use of HostIPC in the pod spec.
hostNetwork
boolean		hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
hostPID
boolean		hostPID determines if the policy allows the use of HostPID in the pod spec.
hostPorts
HostPortRange array		hostPorts determines which host port ranges are allowed to be exposed.
privileged
boolean		privileged determines if a pod can request to be run as privileged.
readOnlyRootFilesystem
boolean		readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
requiredDropCapabilities
string array		requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
runAsUser
RunAsUserStrategyOptions		runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
seLinux
SELinuxStrategyOptions		seLinux is the strategy that will dictate the allowable labels that may be set.
supplementalGroups
SupplementalGroupsStrategyOptions		supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
volumes
string array		volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'.
+

PodSecurityPolicyList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PodSecurityPolicy array		items is a list of schema objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodSecurityPolicy

+

HTTP Request

+

POST /apis/extensions/v1beta1/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
201
PodSecurityPolicy		Created
202
PodSecurityPolicy		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PodSecurityPolicy

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PodSecurityPolicy

+

HTTP Request

+

PUT /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
201
PodSecurityPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PodSecurityPolicy

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PodSecurityPolicy

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicyList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

CLUSTER

+

Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.

+
+
+

APIService v1 apiregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1APIService
+ + + +

APIService represents a server for a particular GroupVersion. Name must be "version.group".

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
APIServiceSpec		Spec contains information for locating and communicating with a server
status
APIServiceStatus		Status contains derived information about an API server
+

APIServiceSpec v1 apiregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
caBundle
string		CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
group
string		Group is the API group name this server hosts
groupPriorityMinimum
integer		GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
insecureSkipTLSVerify
boolean		InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
service
ServiceReference		Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
version
string		Version is the API version this server hosts. For example, "v1"
versionPriority
integer		VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
+

APIServiceStatus v1 apiregistration

+ + + + + + + + + + + + + + + +
FieldDescription
conditions
APIServiceCondition array
patch type: merge
patch merge key: type		Current service state of apiService.
+

APIServiceList v1 apiregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
APIService array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an APIService

+

HTTP Request

+

POST /apis/apiregistration.k8s.io/v1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
202
APIService		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified APIService

+

HTTP Request

+

PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified APIService

+

HTTP Request

+

PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an APIService

+

HTTP Request

+

DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of APIService

+

HTTP Request

+

DELETE /apis/apiregistration.k8s.io/v1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIServiceList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1/watch/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified APIService

+

HTTP Request

+

PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified APIService

+

HTTP Request

+

PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+
+

Binding v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Binding
+

Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
target
ObjectReference		The target object that you want to bind to the standard object.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Binding

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/bindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Binding
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Binding		OK
201
Binding		Created
202
Binding		Accepted
+
+

CertificateSigningRequest v1beta1 certificates.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
certificates.k8s.iov1beta1CertificateSigningRequest
+

Describes a certificate signing request

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
CertificateSigningRequestSpec		The certificate request itself and any additional information.
status
CertificateSigningRequestStatus		Derived information about the request.
+

CertificateSigningRequestSpec v1beta1 certificates

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Extra information about the requesting user. See user.Info interface for details.
groups
string array		Group information about the requesting user. See user.Info interface for details.
request
string		Base64-encoded PKCS#10 CSR data
uid
string		UID information about the requesting user. See user.Info interface for details.
usages
string array		allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12
username
string		Information about the requesting user. See user.Info interface for details.
+

CertificateSigningRequestStatus v1beta1 certificates

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
certificate
string		If request was approved, the controller will place the issued certificate here.
conditions
CertificateSigningRequestCondition array		Conditions applied to the request, such as approval or denial.
+

CertificateSigningRequestList v1beta1 certificates

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
CertificateSigningRequest array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a CertificateSigningRequest

+

HTTP Request

+

POST /apis/certificates.k8s.io/v1beta1/certificatesigningrequests

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
CertificateSigningRequest		Created
202
CertificateSigningRequest		Accepted
200
CertificateSigningRequest		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified CertificateSigningRequest

+

HTTP Request

+

PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified CertificateSigningRequest

+

HTTP Request

+

PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
201
CertificateSigningRequest		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a CertificateSigningRequest

+

HTTP Request

+

DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of CertificateSigningRequest

+

HTTP Request

+

DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequestList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified CertificateSigningRequest

+

HTTP Request

+

PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified CertificateSigningRequest

+

HTTP Request

+

PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
201
CertificateSigningRequest		Created
+
+

ClusterRole v1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1ClusterRole
+ + + +

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
aggregationRule
AggregationRule		AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this ClusterRole
+

ClusterRoleList v1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ClusterRole array		Items is a list of ClusterRoles
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRole

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
201
ClusterRole		Created
202
ClusterRole		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRole

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRole

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ClusterRole		Created
200
ClusterRole		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ClusterRoleBinding v1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1ClusterRoleBinding
+ + + +

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

ClusterRoleBindingList v1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ClusterRoleBinding array		Items is a list of ClusterRoleBindings
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
ClusterRoleBinding		Accepted
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBindingList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ComponentStatus v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ComponentStatus
+

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
conditions
ComponentCondition array
patch type: merge
patch merge key: type		List of component conditions observed
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

ComponentStatusList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ComponentStatus array		List of ComponentStatus objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ComponentStatus

+

HTTP Request

+

GET /api/v1/componentstatuses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ComponentStatus
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ComponentStatus		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list objects of kind ComponentStatus

+

HTTP Request

+

GET /api/v1/componentstatuses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ComponentStatusList		OK
+
+

LocalSubjectAccessReview v1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1LocalSubjectAccessReview
+ + + +

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a LocalSubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
LocalSubjectAccessReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
LocalSubjectAccessReview		OK
201
LocalSubjectAccessReview		Created
202
LocalSubjectAccessReview		Accepted
+
+

Namespace v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Namespace
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NamespaceSpec		Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
NamespaceStatus		Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

NamespaceSpec v1 core

+ + + + + + + + + + + + + + + +
FieldDescription
finalizers
string array		Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
+

NamespaceStatus v1 core

+ + + + + + + + + + + + + + + +
FieldDescription
phase
string		Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
+

NamespaceList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Namespace array		Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Namespace

+

HTTP Request

+

POST /api/v1/namespaces

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Namespace
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
Namespace		Created
202
Namespace		Accepted
200
Namespace		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Namespace

+

HTTP Request

+

PATCH /api/v1/namespaces/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Namespace		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Namespace

+

HTTP Request

+

PUT /api/v1/namespaces/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Namespace
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Namespace		Created
200
Namespace		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Namespace

+

HTTP Request

+

DELETE /api/v1/namespaces/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Namespace

+

HTTP Request

+

GET /api/v1/namespaces/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Namespace		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Namespace

+

HTTP Request

+

GET /api/v1/namespaces

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NamespaceList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Namespace

+

HTTP Request

+

GET /api/v1/watch/namespaces/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Namespace

+

HTTP Request

+

GET /api/v1/watch/namespaces

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Namespace

+

HTTP Request

+

PATCH /api/v1/namespaces/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Namespace		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Namespace

+

HTTP Request

+

GET /api/v1/namespaces/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Namespace		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Namespace

+

HTTP Request

+

PUT /api/v1/namespaces/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Namespace
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Namespace		Created
200
Namespace		OK
+
+

Node v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Node
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NodeSpec		Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
NodeStatus		Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

NodeSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
configSource
NodeConfigSource		If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field
externalID
string		Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
podCIDR
string		PodCIDR represents the pod IP range assigned to the node.
providerID
string		ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
taints
Taint array		If specified, the node's taints.
unschedulable
boolean		Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration
+

NodeStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
addresses
NodeAddress array
patch type: merge
patch merge key: type		List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses
allocatable
object		Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity
object		Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
conditions
NodeCondition array
patch type: merge
patch merge key: type		Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
config
NodeConfigStatus		Status of the config assigned to the node via the dynamic Kubelet config feature.
daemonEndpoints
NodeDaemonEndpoints		Endpoints of daemons running on the Node.
images
ContainerImage array		List of container images on this node
nodeInfo
NodeSystemInfo		Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info
phase
string		NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
volumesAttached
AttachedVolume array		List of volumes that are attached to the node.
volumesInUse
string array		List of attachable volumes in use (mounted) by the node.
+

NodeList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Node array		List of nodes
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Node

+

HTTP Request

+

POST /api/v1/nodes

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Node
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
Node		Accepted
200
Node		OK
201
Node		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Node

+

HTTP Request

+

PATCH /api/v1/nodes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Node		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Node

+

HTTP Request

+

PUT /api/v1/nodes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Node
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Node		Created
200
Node		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Node

+

HTTP Request

+

DELETE /api/v1/nodes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Node

+

HTTP Request

+

DELETE /api/v1/nodes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Node

+

HTTP Request

+

GET /api/v1/nodes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Node		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Node

+

HTTP Request

+

GET /api/v1/nodes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NodeList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Node

+

HTTP Request

+

GET /api/v1/watch/nodes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Node

+

HTTP Request

+

GET /api/v1/watch/nodes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Node

+

HTTP Request

+

PATCH /api/v1/nodes/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Node		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Node

+

HTTP Request

+

GET /api/v1/nodes/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Node		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Node

+

HTTP Request

+

PUT /api/v1/nodes/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Node
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Node		OK
201
Node		Created
+

Proxy Operations

+

See supported operations below...

+

Create Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Node

+

HTTP Request

+

POST /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Create Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Node

+

HTTP Request

+

POST /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Delete Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Node

+

HTTP Request

+

DELETE /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Delete Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Node

+

HTTP Request

+

DELETE /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Get Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Node

+

HTTP Request

+

GET /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Get Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Node

+

HTTP Request

+

GET /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Head Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Node

+

HTTP Request

+

HEAD /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Head Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Node

+

HTTP Request

+

HEAD /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Replace Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Node

+

HTTP Request

+

PUT /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+

Replace Connect Proxy Path

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Node

+

HTTP Request

+

PUT /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
pathpath to the resource
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
string		OK
+
+

PersistentVolume v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PersistentVolume
+ + + + + +

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PersistentVolumeSpec		Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
status
PersistentVolumeStatus		Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
+

PersistentVolumeSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
accessModes
string array		AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
awsElasticBlockStore
AWSElasticBlockStoreVolumeSource		AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDisk
AzureDiskVolumeSource		AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFile
AzureFilePersistentVolumeSource		AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
capacity
object		A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
cephfs
CephFSPersistentVolumeSource		CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cinder
CinderPersistentVolumeSource		Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
claimRef
ObjectReference		ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
csi
CSIPersistentVolumeSource		CSI represents storage that handled by an external CSI driver (Beta feature).
fc
FCVolumeSource		FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
flexVolume
FlexPersistentVolumeSource		FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
flocker
FlockerVolumeSource		Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
gcePersistentDisk
GCEPersistentDiskVolumeSource		GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
glusterfs
GlusterfsVolumeSource		Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath
HostPathVolumeSource		HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
iscsi
ISCSIPersistentVolumeSource		ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
local
LocalVolumeSource		Local represents directly-attached storage with node affinity
mountOptions
string array		A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
nfs
NFSVolumeSource		NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
nodeAffinity
VolumeNodeAffinity		NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
persistentVolumeReclaimPolicy
string		What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
photonPersistentDisk
PhotonPersistentDiskVolumeSource		PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
portworxVolume
PortworxVolumeSource		PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
quobyte
QuobyteVolumeSource		Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd
RBDPersistentVolumeSource		RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
scaleIO
ScaleIOPersistentVolumeSource		ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
storageClassName
string		Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
storageos
StorageOSPersistentVolumeSource		StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md
volumeMode
string		volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.
vsphereVolume
VsphereVirtualDiskVolumeSource		VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+

PersistentVolumeStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
message
string		A human-readable message indicating details about why the volume is in this state.
phase
string		Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
reason
string		Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
+

PersistentVolumeList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PersistentVolume array		List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PersistentVolume

+

HTTP Request

+

POST /api/v1/persistentvolumes

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolume
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
201
PersistentVolume		Created
202
PersistentVolume		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PersistentVolume

+

HTTP Request

+

PATCH /api/v1/persistentvolumes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PersistentVolume

+

HTTP Request

+

PUT /api/v1/persistentvolumes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolume
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
201
PersistentVolume		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PersistentVolume

+

HTTP Request

+

DELETE /api/v1/persistentvolumes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PersistentVolume

+

HTTP Request

+

DELETE /api/v1/persistentvolumes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PersistentVolume

+

HTTP Request

+

GET /api/v1/persistentvolumes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PersistentVolume

+

HTTP Request

+

GET /api/v1/persistentvolumes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PersistentVolume

+

HTTP Request

+

GET /api/v1/watch/persistentvolumes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PersistentVolume

+

HTTP Request

+

GET /api/v1/watch/persistentvolumes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified PersistentVolume

+

HTTP Request

+

PATCH /api/v1/persistentvolumes/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified PersistentVolume

+

HTTP Request

+

GET /api/v1/persistentvolumes/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified PersistentVolume

+

HTTP Request

+

PUT /api/v1/persistentvolumes/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolume
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
201
PersistentVolume		Created
+
+

ResourceQuota v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ResourceQuota
+

ResourceQuota sets aggregate quota restrictions enforced per namespace

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ResourceQuotaSpec		Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
ResourceQuotaStatus		Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

ResourceQuotaSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
hard
object		hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
scopeSelector
ScopeSelector		scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
scopes
string array		A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.
+

ResourceQuotaStatus v1 core

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
hard
object		Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
used
object		Used is the current observed total usage of the resource in the namespace.
+

ResourceQuotaList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ResourceQuota array		Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ResourceQuota

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/resourcequotas

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ResourceQuota
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
201
ResourceQuota		Created
202
ResourceQuota		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ResourceQuota

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ResourceQuota

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ResourceQuota
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
201
ResourceQuota		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ResourceQuota

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ResourceQuota

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/resourcequotas

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ResourceQuota

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/resourcequotas/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ResourceQuota

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/resourcequotas

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuotaList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ResourceQuota

+

HTTP Request

+

GET /api/v1/resourcequotas

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuotaList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ResourceQuota

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ResourceQuota

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/resourcequotas

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ResourceQuota

+

HTTP Request

+

GET /api/v1/watch/resourcequotas

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified ResourceQuota

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified ResourceQuota

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified ResourceQuota

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ResourceQuota
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ResourceQuota		Created
200
ResourceQuota		OK
+
+

Role v1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1Role
+ + + +

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this Role
+

RoleList v1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Role array		Items is a list of Roles
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Role

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
202
Role		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Role

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Role

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

RoleBinding v1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1RoleBinding
+ + + +

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

RoleBindingList v1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
RoleBinding array		Items is a list of RoleBindings
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a RoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
202
RoleBinding		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified RoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified RoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBindingList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBindingList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

SelfSubjectAccessReview v1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1SelfSubjectAccessReview
+ + + +

SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectAccessReviewSpec		Spec holds information about the request being evaluated. user and groups must be empty
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SelfSubjectAccessReviewSpec v1 authorization

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SelfSubjectAccessReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
SelfSubjectAccessReview		OK
201
SelfSubjectAccessReview		Created
202
SelfSubjectAccessReview		Accepted
+
+

SelfSubjectRulesReview v1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1SelfSubjectRulesReview
+ + + +

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectRulesReviewSpec		Spec holds information about the request being evaluated.
status
SubjectRulesReviewStatus		Status is filled in by the server and indicates the set of actions a user can perform.
+

SelfSubjectRulesReviewSpec v1 authorization

+ + + + + + + + + + + + + + + +
FieldDescription
namespace
string		Namespace to evaluate rules for. Required.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectRulesReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SelfSubjectRulesReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
SelfSubjectRulesReview		OK
201
SelfSubjectRulesReview		Created
202
SelfSubjectRulesReview		Accepted
+
+

ServiceAccount v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ServiceAccount
+

ServiceAccount binds together: a name, understood by users, and perhaps by peripheral systems, for an identity a principal that can be authenticated and authorized * a set of secrets

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
automountServiceAccountToken
boolean		AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
imagePullSecrets
LocalObjectReference array		ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
secrets
ObjectReference array
patch type: merge
patch merge key: name		Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret
+

ServiceAccountList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ServiceAccount array		List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ServiceAccount

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/serviceaccounts

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ServiceAccount
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
ServiceAccount		Accepted
200
ServiceAccount		OK
201
ServiceAccount		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ServiceAccount

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceAccount		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ServiceAccount

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ServiceAccount
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ServiceAccount		OK
201
ServiceAccount		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ServiceAccount

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ServiceAccount

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/serviceaccounts

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ServiceAccount

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceAccount		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ServiceAccount

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/serviceaccounts

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceAccountList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ServiceAccount

+

HTTP Request

+

GET /api/v1/serviceaccounts

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceAccountList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ServiceAccount

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ServiceAccount

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/serviceaccounts

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ServiceAccount

+

HTTP Request

+

GET /api/v1/watch/serviceaccounts

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

SubjectAccessReview v1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1SubjectAccessReview
+ + + +

SubjectAccessReview checks whether or not a user or group can perform an action.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SubjectAccessReviewSpec v1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
groups
string array		Groups is the groups you're testing for.
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
uid
string		UID information about the requesting user.
user
string		User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
+

SubjectAccessReviewStatus v1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowed
boolean		Allowed is required. True if the action would be allowed, false otherwise.
denied
boolean		Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
evaluationError
string		EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
reason
string		Reason is optional. It indicates why a request was allowed or denied.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1/subjectaccessreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SubjectAccessReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
SubjectAccessReview		Created
202
SubjectAccessReview		Accepted
200
SubjectAccessReview		OK
+
+

TokenReview v1 authentication.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authentication.k8s.iov1TokenReview
+ + + +

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
TokenReviewSpec		Spec holds information about the request being evaluated
status
TokenReviewStatus		Status is filled in by the server and indicates whether the request can be authenticated.
+

TokenReviewSpec v1 authentication

+ + + + + + + + + + + + + + + +
FieldDescription
token
string		Token is the opaque bearer token.
+

TokenReviewStatus v1 authentication

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
authenticated
boolean		Authenticated indicates that the token was associated with a known user.
error
string		Error indicates that the token couldn't be checked
user
UserInfo		User is the UserInfo associated with the provided token.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a TokenReview

+

HTTP Request

+

POST /apis/authentication.k8s.io/v1/tokenreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
TokenReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
TokenReview		OK
201
TokenReview		Created
202
TokenReview		Accepted
+
+

NetworkPolicy v1 networking.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicy
+ + + +

NetworkPolicy describes what network traffic is allowed for a set of Pods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NetworkPolicySpec		Specification of the desired behavior for this NetworkPolicy.
+

NetworkPolicySpec v1 networking

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
egress
NetworkPolicyEgressRule array		List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
ingress
NetworkPolicyIngressRule array		List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
podSelector
LabelSelector		Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
policyTypes
string array		List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
+

NetworkPolicyList v1 networking

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
NetworkPolicy array		Items is a list of schema objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a NetworkPolicy

+

HTTP Request

+

POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
201
NetworkPolicy		Created
202
NetworkPolicy		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified NetworkPolicy

+

HTTP Request

+

PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified NetworkPolicy

+

HTTP Request

+

PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
201
NetworkPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a NetworkPolicy

+

HTTP Request

+

DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of NetworkPolicy

+

HTTP Request

+

DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicyList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicyList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/watch/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

DEFINITIONS

+

This section contains definitions for objects used in the Kubernetes APIs.

+

APIGroup v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1APIGroup
+

APIGroup contains the name, the supported versions, and the preferred version of a group.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string		name is the name of the group.
preferredVersion
GroupVersionForDiscovery		preferredVersion is the version preferred by the API server, which probably is the storage version.
serverAddressByClientCIDRs
ServerAddressByClientCIDR array		a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
versions
GroupVersionForDiscovery array		versions are the versions supported in this group.
+

APIResource v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1APIResource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
categories
string array		categories is a list of the grouped resources this resource belongs to (e.g. 'all')
group
string		group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
kind
string		kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
name
string		name is the plural name of the resource.
namespaced
boolean		namespaced indicates if a resource is namespaced or not.
shortNames
string array		shortNames is a list of suggested short names of the resource.
singularName
string		singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
verbs
string array		verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
version
string		version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
+

APIServiceCondition v1 apiregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1APIServiceCondition
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		Human-readable message indicating details about last transition.
reason
string		Unique, one-word, CamelCase reason for the condition's last transition.
status
string		Status is the status of the condition. Can be True, False, Unknown.
type
string		Type is the type of the condition.
+

APIVersions v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1APIVersions
+

APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
serverAddressByClientCIDRs
ServerAddressByClientCIDR array		a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
versions
string array		versions are the api versions that are available.
+

AWSElasticBlockStoreVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1AWSElasticBlockStoreVolumeSource
+

Represents a Persistent Disk resource in AWS.

+

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partition
integer		The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
readOnly
boolean		Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID
string		Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+

Affinity v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Affinity
+

Affinity is a group of affinity scheduling rules.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
nodeAffinity
NodeAffinity		Describes node affinity scheduling rules for the pod.
podAffinity
PodAffinity		Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity
PodAntiAffinity		Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+

AggregationRule v1 rbac

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1AggregationRule
+ + +

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

+ + + + + + + + + + + + + + + +
FieldDescription
clusterRoleSelectors
LabelSelector array		ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+

AllowedFlexVolume v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1AllowedFlexVolume
+

AllowedFlexVolume represents a single Flexvolume that is allowed to be used. Deprecated: use AllowedFlexVolume from policy API Group instead.

+ + + + + + + + + + + + + + + +
FieldDescription
driver
string		driver is the name of the Flexvolume driver.
+

AllowedHostPath v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1AllowedHostPath
+

AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined. Deprecated: use AllowedHostPath from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
pathPrefix
string		pathPrefix is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: /foo would allow /foo, /foo/ and /foo/bar /foo would not allow /food or /etc/foo
readOnly
boolean		when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.
+

AttachedVolume v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1AttachedVolume
+

AttachedVolume describes a volume attached to a node

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
devicePath
string		DevicePath represents the device path where the volume should be available
name
string		Name of the attached volume
+

AzureDiskVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1AzureDiskVolumeSource
+

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
cachingMode
string		Host Caching mode: None, Read Only, Read Write.
diskName
string		The Name of the data disk in the blob storage
diskURI
string		The URI the data disk in the blob storage
fsType
string		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.
kind
string		Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+

AzureFilePersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1AzureFilePersistentVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName
string		the name of secret that contains Azure Storage Account Name and Key
secretNamespace
string		the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
shareName
string		Share Name
+

AzureFileVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1AzureFileVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName
string		the name of secret that contains Azure Storage Account Name and Key
shareName
string		Share Name
+

CSIPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1CSIPersistentVolumeSource
+

Represents storage that is managed by an external CSI volume driver (Beta feature)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
controllerPublishSecretRef
SecretReference		ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
driver
string		Driver is the name of the driver to use for this volume. Required.
fsType
string		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.
nodePublishSecretRef
SecretReference		NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
nodeStageSecretRef
SecretReference		NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
readOnly
boolean		Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
volumeAttributes
object		Attributes of the volume to publish.
volumeHandle
string		VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
+

Capabilities v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Capabilities
+

Adds and removes POSIX capabilities from running containers.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
add
string array		Added capabilities
drop
string array		Removed capabilities
+

CephFSPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1CephFSPersistentVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
monitors
string array		Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
path
string		Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly
boolean		Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretFile
string		Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretRef
SecretReference		Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
user
string		Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
+

CephFSVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1CephFSVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
monitors
string array		Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
path
string		Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnly
boolean		Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretFile
string		Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
secretRef
LocalObjectReference		Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
user
string		Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
+

CertificateSigningRequestCondition v1beta1 certificates

+ + + + + + + + + + + + + + + +
GroupVersionKind
certificates.k8s.iov1beta1CertificateSigningRequestCondition
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastUpdateTime
Time		timestamp for the last update to this condition
message
string		human readable message with details about the request state
reason
string		brief reason for the request state
type
string		request approval state, currently Approved or Denied.
+

CinderPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1CinderPersistentVolumeSource
+

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
readOnly
boolean		Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
secretRef
SecretReference		Optional: points to a secret object containing parameters used to connect to OpenStack.
volumeID
string		volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
+

CinderVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1CinderVolumeSource
+

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
readOnly
boolean		Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
secretRef
LocalObjectReference		Optional: points to a secret object containing parameters used to connect to OpenStack.
volumeID
string		volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
+

ClientIPConfig v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ClientIPConfig
+

ClientIPConfig represents the configurations of Client IP based session affinity.

+ + + + + + + + + + + + + + + +
FieldDescription
timeoutSeconds
integer		timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
+

ComponentCondition v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ComponentCondition
+

Information about the condition of a component.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
error
string		Condition error code for a component. For example, a health check error code.
message
string		Message about the condition for a component. For example, information about a health check.
status
string		Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
type
string		Type of condition for a component. Valid value: "Healthy"
+

ConfigMapEnvSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ConfigMapEnvSource
+

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.

+

The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean		Specify whether the ConfigMap must be defined
+

ConfigMapKeySelector v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ConfigMapKeySelector
+

Selects a key from a ConfigMap.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string		The key to select.
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean		Specify whether the ConfigMap or it's key must be defined
+

ConfigMapNodeConfigSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ConfigMapNodeConfigSource
+

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
kubeletConfigKey
string		KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name
string		Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace
string		Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion
string		ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid
string		UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
+

ConfigMapProjection v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ConfigMapProjection
+

Adapts a ConfigMap into a projected volume.

+

The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
items
KeyToPath array		If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean		Specify whether the ConfigMap or it's keys must be defined
+

ConfigMapVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ConfigMapVolumeSource
+

Adapts a ConfigMap into a volume.

+

The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items
KeyToPath array		If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean		Specify whether the ConfigMap or it's keys must be defined
+

ContainerImage v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ContainerImage
+

Describe a container image

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
names
string array		Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
sizeBytes
integer		The size of the image in bytes.
+

ContainerPort v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ContainerPort
+

ContainerPort represents a network port in a single container.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
containerPort
integer		Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
hostIP
string		What host IP to bind the external port to.
hostPort
integer		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.
name
string		If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol
string		Protocol for port. Must be UDP or TCP. Defaults to "TCP".
+

ContainerState v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ContainerState
+

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
running
ContainerStateRunning		Details about a running container
terminated
ContainerStateTerminated		Details about a terminated container
waiting
ContainerStateWaiting		Details about a waiting container
+

ContainerStateRunning v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ContainerStateRunning
+

ContainerStateRunning is a running state of a container.

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

ContainerStateTerminated v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ContainerStateTerminated
+

ContainerStateTerminated is a terminated state of a container.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
containerID
string		Container's ID in the format 'docker://<container_id>'
exitCode
integer		Exit status from the last termination of the container
finishedAt
Time		Time at which the container last terminated
message
string		Message regarding the last termination of the container
reason
string		(brief) reason from the last termination of the container
signal
integer		Signal from the last termination of the container
startedAt
Time		Time at which previous execution of the container started
+

ContainerStateWaiting v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ContainerStateWaiting
+

ContainerStateWaiting is a waiting state of a container.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
message
string		Message regarding why the container is not yet running.
reason
string		(brief) reason the container is not yet running.
+

CrossVersionObjectReference v1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv1CrossVersionObjectReference
+ + +

CrossVersionObjectReference contains enough information to let you identify the referred resource.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		API version of the referent
kind
string		Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds&#34;
name
string		Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+

CustomResourceColumnDefinition v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceColumnDefinition
+

CustomResourceColumnDefinition specifies a column for server side printing.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
JSONPath
string		JSONPath is a simple JSON path, i.e. with array notation.
description
string		description is a human readable description of this column.
format
string		format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more.
name
string		name is a human readable name for the column.
priority
integer		priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a higher priority.
type
string		type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more.
+

CustomResourceDefinitionCondition v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinitionCondition
+

CustomResourceDefinitionCondition contains details for the current condition of this pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		Human-readable message indicating details about last transition.
reason
string		Unique, one-word, CamelCase reason for the condition's last transition.
status
string		Status is the status of the condition. Can be True, False, Unknown.
type
string		Type is the type of the condition.
+

CustomResourceDefinitionNames v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinitionNames
+

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
categories
string array		Categories is a list of grouped resources custom resources belong to (e.g. 'all')
kind
string		Kind is the serialized kind of the resource. It is normally CamelCase and singular.
listKind
string		ListKind is the serialized kind of the list for this resource. Defaults to <kind>List.
plural
string		Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.
shortNames
string array		ShortNames are short names for the resource. It must be all lowercase.
singular
string		Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind>
+

CustomResourceDefinitionVersion v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinitionVersion
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the version name, e.g. “v1”, “v2beta1”, etc.
served
boolean		Served is a flag enabling/disabling this version from being served via REST APIs
storage
boolean		Storage flags the version as storage version. There must be exactly one flagged as storage version.
+

CustomResourceSubresourceScale v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceSubresourceScale
+

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
labelSelectorPath
string		LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. Must be set to work with HPA. If there is no value under the given path in the CustomResource, the status label selector value in the /scale subresource will default to the empty string.
specReplicasPath
string		SpecReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Spec.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the CustomResource, the /scale subresource will return an error on GET.
statusReplicasPath
string		StatusReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the CustomResource, the status replica value in the /scale subresource will default to 0.
+

CustomResourceSubresourceStatus v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceSubresourceStatus
+

CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the .status JSON path inside of a CustomResource. When set, exposes a /status subresource for the custom resource PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza

+ + + + + + + + + + + + + + +
FieldDescription
+

CustomResourceSubresources v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceSubresources
+

CustomResourceSubresources defines the status and scale subresources for CustomResources.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
scale
CustomResourceSubresourceScale		Scale denotes the scale subresource for CustomResources
status
CustomResourceSubresourceStatus		Status denotes the status subresource for CustomResources
+

CustomResourceValidation v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceValidation
+

CustomResourceValidation is a list of validation methods for CustomResources.

+ + + + + + + + + + + + + + + +
FieldDescription
openAPIV3Schema
JSONSchemaProps		OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.
+

DaemonEndpoint v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1DaemonEndpoint
+

DaemonEndpoint contains information about a single Daemon endpoint.

+ + + + + + + + + + + + + + + +
FieldDescription
Port
integer		Port number of the given endpoint.
+

DaemonSetCondition v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1DaemonSetCondition
+ + +

DaemonSetCondition describes the state of a DaemonSet at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of DaemonSet condition.
+

DaemonSetUpdateStrategy v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1DaemonSetUpdateStrategy
+ + +

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDaemonSet		Rolling update config params. Present only if type = "RollingUpdate".
type
string		Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
+

DeleteOptions v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1DeleteOptions
+

DeleteOptions may be provided when deleting an API object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
gracePeriodSeconds
integer		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.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
orphanDependents
boolean		Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
preconditions
Preconditions		Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
propagationPolicy
string		Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

DeploymentCondition v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1DeploymentCondition
+ + +

DeploymentCondition describes the state of a deployment at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
lastUpdateTime
Time		The last time this condition was updated.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of deployment condition.
+

DownwardAPIProjection v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1DownwardAPIProjection
+

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

+ + + + + + + + + + + + + + + +
FieldDescription
items
DownwardAPIVolumeFile array		Items is a list of DownwardAPIVolume file
+

DownwardAPIVolumeFile v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1DownwardAPIVolumeFile
+

DownwardAPIVolumeFile represents information to create the file containing the pod field

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fieldRef
ObjectFieldSelector		Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode
integer		Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path
string		Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRef
ResourceFieldSelector		Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+

DownwardAPIVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1DownwardAPIVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items
DownwardAPIVolumeFile array		Items is a list of downward API volume file
+

EmptyDirVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EmptyDirVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
medium
string		What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimit
Quantity		Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
+

EndpointAddress v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EndpointAddress
+

EndpointAddress is a tuple that describes single IP address.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
hostname
string		The Hostname of this endpoint
ip
string		The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
nodeName
string		Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
targetRef
ObjectReference		Reference to object providing the endpoint.
+

EndpointPort v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EndpointPort
+

EndpointPort is a tuple that describes a single port.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.
port
integer		The port number of the endpoint.
protocol
string		The IP protocol for this port. Must be UDP or TCP. Default is TCP.
+

EndpointSubset v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EndpointSubset
+

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + } +The resulting set of endpoints can be viewed as: + a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + b: [ 10.10.1.1:309, 10.10.2.2:309 ]

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
addresses
EndpointAddress array		IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
notReadyAddresses
EndpointAddress array		IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
ports
EndpointPort array		Port numbers available on the related IP addresses.
+

EnvFromSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EnvFromSource
+

EnvFromSource represents the source of a set of ConfigMaps

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
configMapRef
ConfigMapEnvSource		The ConfigMap to select from
prefix
string		An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef
SecretEnvSource		The Secret to select from
+

EnvVar v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EnvVar
+

EnvVar represents an environment variable present in a Container.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name of the environment variable. Must be a C_IDENTIFIER.
value
string		Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFrom
EnvVarSource		Source for the environment variable's value. Cannot be used if value is not empty.
+

EnvVarSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EnvVarSource
+

EnvVarSource represents a source for the value of an EnvVar.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
configMapKeyRef
ConfigMapKeySelector		Selects a key of a ConfigMap.
fieldRef
ObjectFieldSelector		Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
resourceFieldRef
ResourceFieldSelector		Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
secretKeyRef
SecretKeySelector		Selects a key of a secret in the pod's namespace
+

EventSeries v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EventSeries
+ + +

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
count
integer		Number of occurrences in this series up to the last heartbeat time
lastObservedTime
MicroTime		Time of the last occurrence observed
state
string		State of this Series: Ongoing or Finished
+

EventSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EventSource
+

EventSource contains information for an event.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
component
string		Component from which the event is generated.
host
string		Node name on which the event is generated.
+

Eviction v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1Eviction
+

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/<pod name>/evictions.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
deleteOptions
DeleteOptions		DeleteOptions may be provided
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		ObjectMeta describes the pod that is being evicted.
+

ExecAction v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ExecAction
+

ExecAction describes a "run in container" action.

+ + + + + + + + + + + + + + + + +
FieldDescription
command
string array		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.
+

ExternalDocumentation v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1ExternalDocumentation
+

ExternalDocumentation allows referencing an external resource for extended documentation.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
description
string
url
string
+

ExternalMetricSource v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ExternalMetricSource
+

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). Exactly one "target" type should be set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
metricName
string		metricName is the name of the metric in question.
metricSelector
LabelSelector		metricSelector is used to identify a specific time series within a given metric.
targetAverageValue
Quantity		targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue.
targetValue
Quantity		targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue.
+

ExternalMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ExternalMetricStatus
+

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
currentAverageValue
Quantity		currentAverageValue is the current value of metric averaged over autoscaled pods.
currentValue
Quantity		currentValue is the current value of the metric (as a quantity)
metricName
string		metricName is the name of a metric used for autoscaling in metric system.
metricSelector
LabelSelector		metricSelector is used to identify a specific time series within a given metric.
+

FCVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1FCVolumeSource
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		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.
lun
integer		Optional: FC target lun number
readOnly
boolean		Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs
string array		Optional: FC target worldwide names (WWNs)
wwids
string array		Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+

FSGroupStrategyOptions v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1FSGroupStrategyOptions
+

FSGroupStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use FSGroupStrategyOptions from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ranges
IDRange array		ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs.
rule
string		rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
+

FlexPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1FlexPersistentVolumeSource
+

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
driver
string		Driver is the name of the driver to use for this volume.
fsType
string		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.
options
object		Optional: Extra command options if any.
readOnly
boolean		Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
SecretReference		Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
+

FlexVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1FlexVolumeSource
+

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
driver
string		Driver is the name of the driver to use for this volume.
fsType
string		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.
options
object		Optional: Extra command options if any.
readOnly
boolean		Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
LocalObjectReference		Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
+

FlockerVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1FlockerVolumeSource
+

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
datasetName
string		Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUID
string		UUID of the dataset. This is unique identifier of a Flocker dataset
+

GCEPersistentDiskVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1GCEPersistentDiskVolumeSource
+

Represents a Persistent Disk resource in Google Compute Engine.

+

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partition
integer		The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
pdName
string		Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly
boolean		ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+

GitRepoVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1GitRepoVolumeSource
+

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

+

DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
directory
string		Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repository
string		Repository URL
revision
string		Commit hash for the specified revision.
+

GlusterfsVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1GlusterfsVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
endpoints
string		EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
path
string		Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
readOnly
boolean		ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
+

GroupVersionForDiscovery v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1GroupVersionForDiscovery
+

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
groupVersion
string		groupVersion specifies the API group and version in the form "group/version"
version
string		version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
+

HTTPGetAction v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1HTTPGetAction
+

HTTPGetAction describes an action based on HTTP Get requests.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
host
string		Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
httpHeaders
HTTPHeader array		Custom headers to set in the request. HTTP allows repeated headers.
path
string		Path to access on the HTTP server.
portName 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.
scheme
string		Scheme to use for connecting to the host. Defaults to HTTP.
+

HTTPHeader v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1HTTPHeader
+

HTTPHeader describes a custom header to be used in HTTP probes

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		The header field name
value
string		The header field value
+

HTTPIngressPath v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1HTTPIngressPath
+

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
backend
IngressBackend		Backend defines the referenced service endpoint to which the traffic will be forwarded to.
path
string		Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend.
+

HTTPIngressRuleValue v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1HTTPIngressRuleValue
+

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart&gt; -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

+ + + + + + + + + + + + + + + +
FieldDescription
paths
HTTPIngressPath array		A collection of paths that map requests to backends.
+

Handler v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Handler
+

Handler defines a specific action that should be taken

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
exec
ExecAction		One and only one of the following should be specified. Exec specifies the action to take.
httpGet
HTTPGetAction		HTTPGet specifies the http request to perform.
tcpSocket
TCPSocketAction		TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
+

HorizontalPodAutoscalerCondition v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1HorizontalPodAutoscalerCondition
+

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		lastTransitionTime is the last time the condition transitioned from one status to another
message
string		message is a human-readable explanation containing details about the transition
reason
string		reason is the reason for the condition's last transition.
status
string		status is the status of the condition (True, False, Unknown)
type
string		type describes the current condition
+

HostAlias v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1HostAlias
+

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
hostnames
string array		Hostnames for the above IP address.
ip
string		IP address of the host file entry.
+

HostPathVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1HostPathVolumeSource
+

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
path
string		Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type
string		Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+

HostPortRange v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1HostPortRange
+

HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined. Deprecated: use HostPortRange from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
max
integer		max is the end of the range, inclusive.
min
integer		min is the start of the range, inclusive.
+

IDRange v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IDRange
+

IDRange provides a min/max of an allowed range of IDs. Deprecated: use IDRange from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
max
integer		max is the end of the range, inclusive.
min
integer		min is the start of the range, inclusive.
+

IPBlock v1 networking

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1IPBlock
+ + +

IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
cidr
string		CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
except
string array		Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
+

ISCSIPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ISCSIPersistentVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
chapAuthDiscovery
boolean		whether support iSCSI Discovery CHAP authentication
chapAuthSession
boolean		whether support iSCSI Session CHAP authentication
fsType
string		Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName
string		Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn
string		Target iSCSI Qualified Name.
iscsiInterface
string		iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun
integer		iSCSI Target Lun number.
portals
string array		iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnly
boolean		ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRef
SecretReference		CHAP Secret for iSCSI target and initiator authentication
targetPortal
string		iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
+

ISCSIVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ISCSIVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
chapAuthDiscovery
boolean		whether support iSCSI Discovery CHAP authentication
chapAuthSession
boolean		whether support iSCSI Session CHAP authentication
fsType
string		Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName
string		Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn
string		Target iSCSI Qualified Name.
iscsiInterface
string		iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun
integer		iSCSI Target Lun number.
portals
string array		iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnly
boolean		ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRef
LocalObjectReference		CHAP Secret for iSCSI target and initiator authentication
targetPortal
string		iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
+

IngressBackend v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IngressBackend
+

IngressBackend describes all endpoints for a given service and port.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
serviceName
string		Specifies the name of the referenced service.
servicePortSpecifies the port of the referenced service.
+

IngressRule v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IngressRule
+

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.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
host
string		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 IP in the Spec of the parent Ingress. 2. The : delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.
http
HTTPIngressRuleValue
+

IngressTLS v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IngressTLS
+

IngressTLS describes the transport layer security associated with an Ingress.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
hosts
string array		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.
secretName
string		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.
+

Initializer v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Initializer
+ + +

Initializer is information about an initializer that has not yet completed.

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

Initializers v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Initializers
+

Initializers tracks the progress of initialization.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
pending
Initializer array
patch type: merge
patch merge key: name		Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
result
Status		If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.
+

JSON v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSON
+

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

+ + + + + + + + + + + + + + + +
FieldDescription
Raw
string
+

JSONSchemaProps v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSONSchemaProps
+

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
$ref
string
$schema
string
additionalItems
JSONSchemaPropsOrBool
additionalProperties
JSONSchemaPropsOrBool
allOf
JSONSchemaProps array
anyOf
JSONSchemaProps array
default
JSON
definitions
object
dependencies
object
description
string
enum
JSON array
example
JSON
exclusiveMaximum
boolean
exclusiveMinimum
boolean
externalDocs
ExternalDocumentation
format
string
id
string
items
JSONSchemaPropsOrArray
maxItems
integer
maxLength
integer
maxProperties
integer
maximum
number
minItems
integer
minLength
integer
minProperties
integer
minimum
number
multipleOf
number
not
JSONSchemaProps
oneOf
JSONSchemaProps array
pattern
string
patternProperties
object
properties
object
required
string array
title
string
type
string
uniqueItems
boolean
+

JSONSchemaPropsOrArray v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSONSchemaPropsOrArray
+

JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
JSONSchemas
JSONSchemaProps array
Schema
JSONSchemaProps
+

JSONSchemaPropsOrBool v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSONSchemaPropsOrBool
+

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
Allows
boolean
Schema
JSONSchemaProps
+

JobCondition v1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv1JobCondition
+

JobCondition describes current state of a job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastProbeTime
Time		Last time the condition was checked.
lastTransitionTime
Time		Last time the condition transit from one status to another.
message
string		Human readable message indicating details about last transition.
reason
string		(brief) reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of job condition, Complete or Failed.
+

JobTemplateSpec v1beta1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv1beta1JobTemplateSpec
+ + +

JobTemplateSpec describes the data a Job should have when created from a template

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
metadata
ObjectMeta		Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
JobSpec		Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

KeyToPath v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1KeyToPath
+

Maps a string key to a path within a volume.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string		The key to project.
mode
integer		Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path
string		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 '..'.
+

LabelSelector v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1LabelSelector
+

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
matchExpressions
LabelSelectorRequirement array		matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels
object		matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
+

LabelSelectorRequirement v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1LabelSelectorRequirement
+

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string
patch type: merge
patch merge key: key		key is the label key that the selector applies to.
operator
string		operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
string array		values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+

Lifecycle v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Lifecycle
+

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.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
postStart
Handler		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: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
preStop
Handler		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: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+

LimitRangeItem v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1LimitRangeItem
+

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
default
object		Default resource requirement limit value by resource name if resource limit is omitted.
defaultRequest
object		DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
max
object		Max usage constraints on this kind by resource name.
maxLimitRequestRatio
object		MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
min
object		Min usage constraints on this kind by resource name.
type
string		Type of resource that this limit applies to.
+

ListMeta v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1ListMeta
+

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
continue
string		continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
resourceVersion
string		String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
selfLink
string		selfLink is a URL representing this object. Populated by the system. Read-only.
+

LoadBalancerIngress v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1LoadBalancerIngress
+

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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
hostname
string		Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip
string		IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
+

LoadBalancerStatus v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1LoadBalancerStatus
+

LoadBalancerStatus represents the status of a load-balancer.

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

LocalObjectReference v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1LocalObjectReference
+

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

+ + + + + + + + + + + + + + + +
FieldDescription
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+

LocalVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1LocalVolumeSource
+

Local represents directly-attached storage with node affinity (Beta feature)

+ + + + + + + + + + + + + + + +
FieldDescription
path
string		The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). Directories can be represented only by PersistentVolume with VolumeMode=Filesystem. Block devices can be represented only by VolumeMode=Block, which also requires the BlockVolume alpha feature gate to be enabled.
+

MetricSpec v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1MetricSpec
+

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
external
ExternalMetricSource		external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
object
ObjectMetricSource		object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
pods
PodsMetricSource		pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
resource
ResourceMetricSource		resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
type
string		type is the type of metric source. It should be one of "Object", "Pods" or "Resource", each mapping to a matching field in the object.
+

MetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1MetricStatus
+

MetricStatus describes the last-read state of a single metric.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
external
ExternalMetricStatus		external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
object
ObjectMetricStatus		object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
pods
PodsMetricStatus		pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
resource
ResourceMetricStatus		resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
type
string		type is the type of metric source. It will be one of "Object", "Pods" or "Resource", each corresponds to a matching field in the object.
+

MicroTime v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1MicroTime
+ + + + + + + + + + + + + + +
FieldDescription
+

NFSVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NFSVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
path
string		Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnly
boolean		ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server
string		Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+

NetworkPolicyEgressRule v1 networking

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyEgressRule
+ + +

NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ports
NetworkPolicyPort array		List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
to
NetworkPolicyPeer array		List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
+

NetworkPolicyIngressRule v1 networking

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyIngressRule
+ + +

NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
from
NetworkPolicyPeer array		List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.
ports
NetworkPolicyPort array		List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
+

NetworkPolicyPeer v1 networking

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyPeer
+ + +

NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
ipBlock
IPBlock		IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
namespaceSelector
LabelSelector		Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
podSelector
LabelSelector		This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
+

NetworkPolicyPort v1 networking

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyPort
+ + +

NetworkPolicyPort describes a port to allow traffic on

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
portThe port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers.
protocol
string		The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.
+

NodeAddress v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeAddress
+

NodeAddress contains information for the node's address.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
address
string		The node address.
type
string		Node address type, one of Hostname, ExternalIP or InternalIP.
+

NodeAffinity v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeAffinity
+

Node affinity is a group of node affinity scheduling rules.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
preferredDuringSchedulingIgnoredDuringExecution
PreferredSchedulingTerm array		The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
NodeSelector		If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
+

NodeCondition v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeCondition
+

NodeCondition contains condition information for a node.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastHeartbeatTime
Time		Last time we got an update on a given condition.
lastTransitionTime
Time		Last time the condition transit from one status to another.
message
string		Human readable message indicating details about last transition.
reason
string		(brief) reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of node condition.
+

NodeConfigSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeConfigSource
+

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

+ + + + + + + + + + + + + + + +
FieldDescription
configMap
ConfigMapNodeConfigSource		ConfigMap is a reference to a Node's ConfigMap
+

NodeConfigStatus v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeConfigStatus
+

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
active
NodeConfigSource		Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error.
assigned
NodeConfigSource		Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned.
error
string		Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.
lastKnownGood
NodeConfigSource		LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future.
+

NodeDaemonEndpoints v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeDaemonEndpoints
+

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

+ + + + + + + + + + + + + + + +
FieldDescription
kubeletEndpoint
DaemonEndpoint		Endpoint on which Kubelet is listening.
+

NodeSelector v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeSelector
+

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

+ + + + + + + + + + + + + + + +
FieldDescription
nodeSelectorTerms
NodeSelectorTerm array		Required. A list of node selector terms. The terms are ORed.
+

NodeSelectorRequirement v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeSelectorRequirement
+

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string		The label key that the selector applies to.
operator
string		Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
string array		An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
+

NodeSelectorTerm v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeSelectorTerm
+

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
matchExpressions
NodeSelectorRequirement array		A list of node selector requirements by node's labels.
matchFields
NodeSelectorRequirement array		A list of node selector requirements by node's fields.
+

NodeSystemInfo v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeSystemInfo
+

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
architecture
string		The Architecture reported by the node
bootID
string		Boot ID reported by the node.
containerRuntimeVersion
string		ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
kernelVersion
string		Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
kubeProxyVersion
string		KubeProxy Version reported by the node.
kubeletVersion
string		Kubelet Version reported by the node.
machineID
string		MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
operatingSystem
string		The Operating System reported by the node
osImage
string		OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
systemUUID
string		SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html
+

NonResourceAttributes v1 authorization

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1NonResourceAttributes
+ + +

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
path
string		Path is the URL path of the request
verb
string		Verb is the standard HTTP verb
+

NonResourceRule v1 authorization

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1NonResourceRule
+ + +

NonResourceRule holds information that describes a rule for the non-resource

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
nonResourceURLs
string array		NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
verbs
string array		Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
+

ObjectFieldSelector v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ObjectFieldSelector
+

ObjectFieldSelector selects an APIVersioned field of an object.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath
string		Path of the field to select in the specified API version.
+

ObjectMeta v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1ObjectMeta
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
annotations
object		Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
clusterName
string		The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp
Time		CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
deletionGracePeriodSeconds
integer		Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp
Time		DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
finalizers
string array
patch type: merge		Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
generateName
string		GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
generation
integer		A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
initializers
Initializers		An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
labels
object		Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
name
string		Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
namespace
string		Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
ownerReferences
OwnerReference array
patch type: merge
patch merge key: uid		List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion
string		An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
selfLink
string		SelfLink is a URL representing this object. Populated by the system. Read-only.
uid
string		UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+

ObjectMetricSource v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ObjectMetricSource
+

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
metricName
string		metricName is the name of the metric in question.
target
CrossVersionObjectReference		target is the described Kubernetes object.
targetValue
Quantity		targetValue is the target value of the metric (as a quantity).
+

ObjectMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ObjectMetricStatus
+

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
currentValue
Quantity		currentValue is the current value of the metric (as a quantity).
metricName
string		metricName is the name of the metric in question.
target
CrossVersionObjectReference		target is the described Kubernetes object.
+

ObjectReference v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ObjectReference
+

ObjectReference contains enough information to let you inspect or modify the referred object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		API version of the referent.
fieldPath
string		If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kind
string		Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace
string		Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersion
string		Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
uid
string		UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+

OwnerReference v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1OwnerReference
+

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		API version of the referent.
blockOwnerDeletion
boolean		If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller
boolean		If true, this reference points to the managing controller.
kind
string		Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string		Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
uid
string		UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+

Patch v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Patch
+

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

+ + + + + + + + + + + + +
FieldDescription
+

PersistentVolumeClaimCondition v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PersistentVolumeClaimCondition
+

PersistentVolumeClaimCondition contails details about state of pvc

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastProbeTime
Time		Last time we probed the condition.
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		Human-readable message indicating details about last transition.
reason
string		Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
status
string
type
string
+

PersistentVolumeClaimVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PersistentVolumeClaimVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
claimName
string		ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnly
boolean		Will force the ReadOnly setting in VolumeMounts. Default false.
+

PhotonPersistentDiskVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PhotonPersistentDiskVolumeSource
+

Represents a Photon Controller persistent disk resource.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		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.
pdID
string		ID that identifies Photon Controller persistent disk
+

PodAffinity v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodAffinity
+

Pod affinity is a group of inter pod affinity scheduling rules.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
preferredDuringSchedulingIgnoredDuringExecution
WeightedPodAffinityTerm array		The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
PodAffinityTerm array		If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+

PodAffinityTerm v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodAffinityTerm
+

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
labelSelector
LabelSelector		A label query over a set of resources, in this case pods.
namespaces
string array		namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
topologyKey
string		This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+

PodAntiAffinity v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodAntiAffinity
+

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
preferredDuringSchedulingIgnoredDuringExecution
WeightedPodAffinityTerm array		The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
PodAffinityTerm array		If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+

PodCondition v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodCondition
+

PodCondition contains details for the current condition of this pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastProbeTime
Time		Last time we probed the condition.
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		Human-readable message indicating details about last transition.
reason
string		Unique, one-word, CamelCase reason for the condition's last transition.
status
string		Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
type
string		Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+

PodDNSConfig v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodDNSConfig
+

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
nameservers
string array		A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
options
PodDNSConfigOption array		A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
searches
string array		A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
+

PodDNSConfigOption v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodDNSConfigOption
+

PodDNSConfigOption defines DNS resolver options of a pod.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Required.
value
string
+

PodReadinessGate v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodReadinessGate
+

PodReadinessGate contains the reference to a pod condition

+ + + + + + + + + + + + + + + +
FieldDescription
conditionType
string		ConditionType refers to a condition in the pod's condition list with matching type.
+

PodSecurityContext v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodSecurityContext
+

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsGroup
integer		A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.
runAsGroup
integer		The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
runAsNonRoot
boolean		Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser
integer		The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
seLinuxOptions
SELinuxOptions		The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
supplementalGroups
integer array		A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
sysctls
Sysctl array		Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+

PodsMetricSource v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1PodsMetricSource
+

PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
metricName
string		metricName is the name of the metric in question
targetAverageValue
Quantity		targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)
+

PodsMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1PodsMetricStatus
+

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
currentAverageValue
Quantity		currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
metricName
string		metricName is the name of the metric in question
+

PolicyRule v1 rbac

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1PolicyRule
+ + +

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array		NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array		Resources is a list of resources this rule applies to. ResourceAll represents all resources.
verbs
string array		Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+

PortworxVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PortworxVolumeSource
+

PortworxVolumeSource represents a Portworx volume resource.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeID
string		VolumeID uniquely identifies a Portworx volume
+

Preconditions v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Preconditions
+

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

+ + + + + + + + + + + + + + + +
FieldDescription
uid
string		Specifies the target UID.
+

PreferredSchedulingTerm v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PreferredSchedulingTerm
+

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
preference
NodeSelectorTerm		A node selector term, associated with the corresponding weight.
weight
integer		Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+

Probe v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Probe
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
exec
ExecAction		One and only one of the following should be specified. Exec specifies the action to take.
failureThreshold
integer		Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
httpGet
HTTPGetAction		HTTPGet specifies the http request to perform.
initialDelaySeconds
integer		Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSeconds
integer		How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold
integer		Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
tcpSocket
TCPSocketAction		TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
timeoutSeconds
integer		Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+

ProjectedVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ProjectedVolumeSource
+

Represents a projected volume source

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
sources
VolumeProjection array		list of volume projections
+

Quantity resource core

+ + + + + + + + + + + + + + + +
GroupVersionKind
coreresourceQuantity
+ + + + + + + + + + + + + + +
FieldDescription
+

QuobyteVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1QuobyteVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
group
string		Group to map volume access to Default is no group
readOnly
boolean		ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registry
string		Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
user
string		User to map volume access to Defaults to serivceaccount user
volume
string		Volume is a string that references an already created Quobyte volume by name.
+

RBDPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1RBDPersistentVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image
string		The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
keyring
string		Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
monitors
string array		A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
pool
string		The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
readOnly
boolean		ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
secretRef
SecretReference		SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
user
string		The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
+

RBDVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1RBDVolumeSource
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image
string		The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
keyring
string		Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
monitors
string array		A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
pool
string		The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
readOnly
boolean		ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
secretRef
LocalObjectReference		SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
user
string		The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
+

ReplicaSetCondition v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1ReplicaSetCondition
+ + +

ReplicaSetCondition describes the state of a replica set at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		The last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of replica set condition.
+

ReplicationControllerCondition v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ReplicationControllerCondition
+

ReplicationControllerCondition describes the state of a replication controller at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		The last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of replication controller condition.
+

ResourceAttributes v1 authorization

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1ResourceAttributes
+ + +

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
group
string		Group is the API Group of the Resource. "*" means all.
name
string		Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
namespace
string		Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
resource
string		Resource is one of the existing resource types. "*" means all.
subresource
string		Subresource is one of the existing resource types. "" means none.
verb
string		Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
version
string		Version is the API Version of the Resource. "*" means all.
+

ResourceFieldSelector v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ResourceFieldSelector
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
containerName
string		Container name: required for volumes, optional for env vars
divisor
Quantity		Specifies the output format of the exposed resources, defaults to "1"
resource
string		Required: resource to select
+

ResourceMetricSource v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ResourceMetricSource
+

ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		name is the name of the resource in question.
targetAverageUtilization
integer		targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
targetAverageValue
Quantity		targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type.
+

ResourceMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ResourceMetricStatus
+

ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
currentAverageUtilization
integer		currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if targetAverageValue was set in the corresponding metric specification.
currentAverageValue
Quantity		currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification.
name
string		name is the name of the resource in question.
+

ResourceRequirements v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ResourceRequirements
+

ResourceRequirements describes the compute resource requirements.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
limits
object		Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
requests
object		Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
+

ResourceRule v1 authorization

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1ResourceRule
+ + +

ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
resources
string array		Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
verbs
string array		Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
+

RoleRef v1 rbac

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1RoleRef
+ + +

RoleRef contains information that points to the role being used

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroup
string		APIGroup is the group for the resource being referenced
kind
string		Kind is the type of resource being referenced
name
string		Name is the name of resource being referenced
+

RollbackConfig v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1RollbackConfig
+

DEPRECATED.

+ + + + + + + + + + + + + + + +
FieldDescription
revision
integer		The revision to rollback to. If set to 0, rollback to the last revision.
+

RollingUpdateStatefulSetStrategy v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1RollingUpdateStatefulSetStrategy
+ + +

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

+ + + + + + + + + + + + + + + +
FieldDescription
partition
integer		Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
+

Rule v1alpha1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1alpha1Rule
+

Rule is a tuple of APIGroups, APIVersion, and Resources.It is recommended to make sure that all the tuple expansions are valid.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
apiVersions
string array		APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
resources
string array		Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
+

RuleWithOperations v1beta1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1RuleWithOperations
+

RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
apiVersions
string array		APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
operations
string array		Operations is the operations the admission hook cares about - CREATE, UPDATE, or for all operations. If '\' is present, the length of the slice must be one. Required.
resources
string array		Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
+

RunAsUserStrategyOptions v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1RunAsUserStrategyOptions
+

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use RunAsUserStrategyOptions from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ranges
IDRange array		ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs.
rule
string		rule is the strategy that will dictate the allowable RunAsUser values that may be set.
+

SELinuxOptions v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SELinuxOptions
+

SELinuxOptions are the labels to be applied to the container

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
level
string		Level is SELinux level label that applies to the container.
role
string		Role is a SELinux role label that applies to the container.
type
string		Type is a SELinux type label that applies to the container.
user
string		User is a SELinux user label that applies to the container.
+

SELinuxStrategyOptions v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1SELinuxStrategyOptions
+

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use SELinuxStrategyOptions from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rule
string		rule is the strategy that will dictate the allowable labels that may be set.
seLinuxOptions
SELinuxOptions		seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+

Scale v1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv1Scale
+ + +

Scale represents a scaling request for a resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleIOPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ScaleIOPersistentVolumeSource
+

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		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.
gateway
string		The host address of the ScaleIO API Gateway.
protectionDomain
string		The name of the ScaleIO Protection Domain for the configured storage.
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
SecretReference		SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled
boolean		Flag to enable/disable SSL communication with Gateway, default false
storageMode
string		Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
storagePool
string		The ScaleIO Storage Pool associated with the protection domain.
system
string		The name of the storage system as configured in ScaleIO.
volumeName
string		The name of a volume already created in the ScaleIO system that is associated with this volume source.
+

ScaleIOVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ScaleIOVolumeSource
+

ScaleIOVolumeSource represents a persistent ScaleIO volume

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		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.
gateway
string		The host address of the ScaleIO API Gateway.
protectionDomain
string		The name of the ScaleIO Protection Domain for the configured storage.
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
LocalObjectReference		SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled
boolean		Flag to enable/disable SSL communication with Gateway, default false
storageMode
string		Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
storagePool
string		The ScaleIO Storage Pool associated with the protection domain.
system
string		The name of the storage system as configured in ScaleIO.
volumeName
string		The name of a volume already created in the ScaleIO system that is associated with this volume source.
+

ScopeSelector v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ScopeSelector
+

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

+ + + + + + + + + + + + + + + +
FieldDescription
matchExpressions
ScopedResourceSelectorRequirement array		A list of scope selector requirements by scope of the resources.
+

ScopedResourceSelectorRequirement v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ScopedResourceSelectorRequirement
+

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
operator
string		Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
scopeName
string		The name of the scope that the selector applies to.
values
string array		An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+

SecretEnvSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SecretEnvSource
+

SecretEnvSource selects a Secret to populate the environment variables with.

+

The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean		Specify whether the Secret must be defined
+

SecretKeySelector v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SecretKeySelector
+

SecretKeySelector selects a key of a Secret.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string		The key of the secret to select from. Must be a valid secret key.
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean		Specify whether the Secret or it's key must be defined
+

SecretProjection v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SecretProjection
+

Adapts a secret into a projected volume.

+

The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
items
KeyToPath array		If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name
string		Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean		Specify whether the Secret or its key must be defined
+

SecretReference v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SecretReference
+

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is unique within a namespace to reference a secret resource.
namespace
string		Namespace defines the space within which the secret name must be unique.
+

SecretVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SecretVolumeSource
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items
KeyToPath array		If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
optional
boolean		Specify whether the Secret or it's keys must be defined
secretName
string		Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+

SecurityContext v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SecurityContext
+

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowPrivilegeEscalation
boolean		AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
capabilities
Capabilities		The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
privileged
boolean		Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
readOnlyRootFilesystem
boolean		Whether this container has a read-only root filesystem. Default is false.
runAsGroup
integer		The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
boolean		Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser
integer		The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
seLinuxOptions
SELinuxOptions		The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+

ServerAddressByClientCIDR v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1ServerAddressByClientCIDR
+

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
clientCIDR
string		The CIDR with which clients can match their IP to figure out the server address that they should use.
serverAddress
string		Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.
+

ServiceAccountTokenProjection v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ServiceAccountTokenProjection
+

ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
audience
string		Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds
integer		ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path
string		Path is the path relative to the mount point of the file to project the token into.
+

ServicePort v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ServicePort
+

ServicePort contains information on service's port.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.
nodePort
integer		The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
port
integer		The port that will be exposed by this service.
protocol
string		The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.
targetPortNumber or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+

ServiceReference v1 apiregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1ServiceReference
+ + +

ServiceReference holds a reference to Service.legacy.k8s.io

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the name of the service
namespace
string		Namespace is the namespace of the service
+

SessionAffinityConfig v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SessionAffinityConfig
+

SessionAffinityConfig represents the configurations of session affinity.

+ + + + + + + + + + + + + + + +
FieldDescription
clientIP
ClientIPConfig		clientIP contains the configurations of Client IP based session affinity.
+

StatefulSetCondition v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1StatefulSetCondition
+ + +

StatefulSetCondition describes the state of a statefulset at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of statefulset condition.
+

StatefulSetUpdateStrategy v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1StatefulSetUpdateStrategy
+ + +

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateStatefulSetStrategy		RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
type
string		Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
+

Status v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Status
+

Status is a return value for calls that don't return other objects.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
code
integer		Suggested HTTP return code for this status, 0 if not set.
details
StatusDetails		Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
kind
string		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: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
message
string		A human-readable description of the status of this operation.
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
reason
string		A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status
string		Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

StatusCause v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1StatusCause
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
field
string		The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
message
string		A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason
string		A machine-readable description of the cause of the error. If this value is empty there is no information available.
+

StatusDetails v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1StatusDetails
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
causes
StatusCause array		The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group
string		The group attribute of the resource associated with the status StatusReason.
kind
string		The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string		The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds
integer		If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
uid
string		UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+

StorageOSPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1StorageOSPersistentVolumeSource
+

Represents a StorageOS persistent volume resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		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.
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
ObjectReference		SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volumeName
string		VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace
string		VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
+

StorageOSVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1StorageOSVolumeSource
+

Represents a StorageOS persistent volume resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		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.
readOnly
boolean		Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
LocalObjectReference		SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volumeName
string		VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace
string		VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
+

Subject v1 rbac

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1Subject
+ + +

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroup
string		APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
kind
string		Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string		Name of the object being referenced.
namespace
string		Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+

SubjectRulesReviewStatus v1 authorization

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1SubjectRulesReviewStatus
+ + +

SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
evaluationError
string		EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
incomplete
boolean		Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
nonResourceRules
NonResourceRule array		NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
resourceRules
ResourceRule array		ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+

SupplementalGroupsStrategyOptions v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1SupplementalGroupsStrategyOptions
+

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use SupplementalGroupsStrategyOptions from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ranges
IDRange array		ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs.
rule
string		rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
+

Sysctl v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Sysctl
+

Sysctl defines a kernel parameter to be set

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name of a property to set
value
string		Value of a property to set
+

TCPSocketAction v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1TCPSocketAction
+

TCPSocketAction describes an action based on opening a socket

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
host
string		Optional: Host name to connect to, defaults to the pod IP.
portNumber 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.
+

Taint v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Taint
+

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
effect
string		Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
key
string		Required. The taint key to be applied to a node.
timeAdded
Time		TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
value
string		Required. The taint value corresponding to the taint key.
+

Time v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Time
+ + + + + + + + + + + + + + +
FieldDescription
+

Toleration v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Toleration
+

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
effect
string		Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
string		Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
string		Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds
integer		TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
value
string		Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+

TopologySelectorLabelRequirement v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1TopologySelectorLabelRequirement
+

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string		The label key that the selector applies to.
values
string array		An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
+

TopologySelectorTerm v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1TopologySelectorTerm
+

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

+ + + + + + + + + + + + + + + +
FieldDescription
matchLabelExpressions
TopologySelectorLabelRequirement array		A list of topology selector requirements by labels.
+

UserInfo v1 authentication

+ + + + + + + + + + + + + + + +
GroupVersionKind
authentication.k8s.iov1UserInfo
+ + +

UserInfo holds the information about the user needed to implement the user.Info interface.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Any additional information provided by the authenticator.
groups
string array		The names of groups this user is a part of.
uid
string		A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
username
string		The name that uniquely identifies this user among all active users.
+

VolumeAttachmentSource v1beta1 storage

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1VolumeAttachmentSource
+ + +

VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.

+ + + + + + + + + + + + + + + +
FieldDescription
persistentVolumeName
string		Name of the persistent volume to attach.
+

VolumeDevice v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1VolumeDevice
+

volumeDevice describes a mapping of a raw block device within a container.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
devicePath
string		devicePath is the path inside of the container that the device will be mapped to.
name
string		name must match the name of a persistentVolumeClaim in the pod
+

VolumeError v1beta1 storage

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1VolumeError
+ + +

VolumeError captures an error encountered during a volume operation.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
message
string		String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
time
Time		Time the error was encountered.
+

VolumeMount v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1VolumeMount
+

VolumeMount describes a mounting of a Volume within a container.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
mountPath
string		Path within the container at which the volume should be mounted. Must not contain ':'.
mountPropagation
string		mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is beta in 1.10.
name
string		This must match the Name of a Volume.
readOnly
boolean		Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
subPath
string		Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+

VolumeNodeAffinity v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1VolumeNodeAffinity
+

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

+ + + + + + + + + + + + + + + +
FieldDescription
required
NodeSelector		Required specifies hard node constraints that must be met.
+

VolumeProjection v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1VolumeProjection
+

Projection that may be projected along with other supported volume types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
configMap
ConfigMapProjection		information about the configMap data to project
downwardAPI
DownwardAPIProjection		information about the downwardAPI data to project
secret
SecretProjection		information about the secret data to project
serviceAccountToken
ServiceAccountTokenProjection		information about the serviceAccountToken data to project
+

VsphereVirtualDiskVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1VsphereVirtualDiskVolumeSource
+

Represents a vSphere volume resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		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.
storagePolicyID
string		Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyName
string		Storage Policy Based Management (SPBM) profile name.
volumePath
string		Path that identifies vSphere volume vmdk
+

WatchEvent v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1WatchEvent
+

Event represents a single event to a watched resource.

+ + + + + + + + + + + + + + + + + +
FieldDescription
objectObject is: If Type is Added or Modified: the new state of the object. If Type is Deleted: the state of the object immediately before deletion. If Type is Error: Status is recommended; other types may make sense depending on context.
type
string
+

Webhook v1beta1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1Webhook
+

Webhook describes an admission webhook and the resources and operations it applies to.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
clientConfig
WebhookClientConfig		ClientConfig defines how to communicate with the hook. Required
failurePolicy
string		FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.
name
string		The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
namespaceSelector
LabelSelector		NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything.
rules
RuleWithOperations array		Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches any Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
+

WebhookClientConfig v1beta1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1WebhookClientConfig
+

WebhookClientConfig contains the information to make a TLS connection with the webhook

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
caBundle
string		caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. Required.
service
ServiceReference		service is a reference to the service for this webhook. Either service or url must be specified. If the webhook is running within the cluster, then you should use service. Port 443 will be used if it is open, otherwise it is an error.
url
string		url gives the location of the webhook, in standard URL form ([scheme://]host:port/path). Exactly one of url or service must be specified. The host should not refer to a service running in the cluster; use the service field instead. The host might be resolved via external DNS in some apiservers (e.g., kube-apiserver cannot resolve in-cluster DNS as that would be a layering violation). host may also be an IP address. Please note that using localhost or 127.0.0.1 as a host is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://&#34;. A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
+

WeightedPodAffinityTerm v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1WeightedPodAffinityTerm
+

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
podAffinityTerm
PodAffinityTerm		Required. A pod affinity term, associated with the corresponding weight.
weight
integer		weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+

OLD API VERSIONS

+

This section contains older versions of resources shown above.

+
+

APIService v1beta1 apiregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1APIService
+ + + +

APIService represents a server for a particular GroupVersion. Name must be "version.group".

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
APIServiceSpec		Spec contains information for locating and communicating with a server
status
APIServiceStatus		Status contains derived information about an API server
+

APIServiceSpec v1beta1 apiregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
caBundle
string		CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
group
string		Group is the API group name this server hosts
groupPriorityMinimum
integer		GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
insecureSkipTLSVerify
boolean		InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
service
ServiceReference		Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
version
string		Version is the API version this server hosts. For example, "v1"
versionPriority
integer		VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
+

APIServiceStatus v1beta1 apiregistration

+ + + + + + + + + + + + + + + +
FieldDescription
conditions
APIServiceCondition array
patch type: merge
patch merge key: type		Current service state of apiService.
+

APIServiceList v1beta1 apiregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
APIService array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an APIService

+

HTTP Request

+

POST /apis/apiregistration.k8s.io/v1beta1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
202
APIService		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified APIService

+

HTTP Request

+

PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified APIService

+

HTTP Request

+

PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an APIService

+

HTTP Request

+

DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of APIService

+

HTTP Request

+

DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIServiceList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified APIService

+

HTTP Request

+

PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified APIService

+

HTTP Request

+

PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+
+

APIServiceCondition v1beta1 apiregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1APIServiceCondition
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		Human-readable message indicating details about last transition.
reason
string		Unique, one-word, CamelCase reason for the condition's last transition.
status
string		Status is the status of the condition. Can be True, False, Unknown.
type
string		Type is the type of the condition.
+
+

AggregationRule v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1AggregationRule
+ + + +

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

+ + + + + + + + + + + + + + + +
FieldDescription
clusterRoleSelectors
LabelSelector array		ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+
+

AggregationRule v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1AggregationRule
+ + + +

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

+ + + + + + + + + + + + + + + +
FieldDescription
clusterRoleSelectors
LabelSelector array		ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+
+

AllowedFlexVolume v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1AllowedFlexVolume
+

AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

+ + + + + + + + + + + + + + + +
FieldDescription
driver
string		driver is the name of the Flexvolume driver.
+
+

AllowedHostPath v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1AllowedHostPath
+

AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
pathPrefix
string		pathPrefix is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: /foo would allow /foo, /foo/ and /foo/bar /foo would not allow /food or /etc/foo
readOnly
boolean		when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.
+
+

ClusterRole v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1ClusterRole
+ + + +

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
aggregationRule
AggregationRule		AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this ClusterRole
+

ClusterRoleList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ClusterRole array		Items is a list of ClusterRoles
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRole

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
201
ClusterRole		Created
202
ClusterRole		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRole

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRole

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
201
ClusterRole		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ClusterRole v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1ClusterRole
+ + + +

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
aggregationRule
AggregationRule		AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this ClusterRole
+

ClusterRoleList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ClusterRole array		Items is a list of ClusterRoles
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRole

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
201
ClusterRole		Created
202
ClusterRole		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRole

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRole

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
201
ClusterRole		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ClusterRoleBinding v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1ClusterRoleBinding
+ + + +

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

ClusterRoleBindingList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ClusterRoleBinding array		Items is a list of ClusterRoleBindings
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
202
ClusterRoleBinding		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBindingList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ClusterRoleBinding v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1ClusterRoleBinding
+ + + +

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

ClusterRoleBindingList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ClusterRoleBinding array		Items is a list of ClusterRoleBindings
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
202
ClusterRoleBinding		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBindingList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ControllerRevision v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2ControllerRevision
+ + + +

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
dataData is the serialized representation of the state.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
revision
integer		Revision indicates the revision of the state represented by Data.
+

ControllerRevisionList v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ControllerRevision array		Items is the list of ControllerRevisions
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ControllerRevision

+

HTTP Request

+

POST /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
201
ControllerRevision		Created
202
ControllerRevision		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ControllerRevision

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ControllerRevision

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ControllerRevision		Created
200
ControllerRevision		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevisionList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevisionList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ControllerRevision v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1ControllerRevision
+ + + +

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
dataData is the serialized representation of the state.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
revision
integer		Revision indicates the revision of the state represented by Data.
+

ControllerRevisionList v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ControllerRevision array		Items is the list of ControllerRevisions
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ControllerRevision

+

HTTP Request

+

POST /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
ControllerRevision		Accepted
200
ControllerRevision		OK
201
ControllerRevision		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ControllerRevision

+

HTTP Request

+

PATCH /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ControllerRevision

+

HTTP Request

+

PUT /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
201
ControllerRevision		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevisionList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevisionList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ControllerRevision
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

CronJob v2alpha1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv2alpha1CronJob
+ + + +

CronJob represents the configuration of a single cron job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
CronJobSpec		Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
CronJobStatus		Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

CronJobSpec v2alpha1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
concurrencyPolicy
string		Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
failedJobsHistoryLimit
integer		The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
jobTemplate
JobTemplateSpec		Specifies the job that will be created when executing a CronJob.
schedule
string		The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
startingDeadlineSeconds
integer		Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
successfulJobsHistoryLimit
integer		The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
suspend
boolean		This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
+

CronJobStatus v2alpha1 batch

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
active
ObjectReference array		A list of pointers to currently running jobs.
lastScheduleTime
Time		Information when was the last time the job was successfully scheduled.
+

CronJobList v2alpha1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
CronJob array		items is the list of CronJobs.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a CronJob

+

HTTP Request

+

POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
201
CronJob		Created
202
CronJob		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified CronJob

+

HTTP Request

+

PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified CronJob

+

HTTP Request

+

PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
201
CronJob		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a CronJob

+

HTTP Request

+

DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of CronJob

+

HTTP Request

+

DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJobList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJobList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/watch/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified CronJob

+

HTTP Request

+

PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified CronJob

+

HTTP Request

+

PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the CronJob
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
201
CronJob		Created
+
+

CrossVersionObjectReference v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1CrossVersionObjectReference
+ + + +

CrossVersionObjectReference contains enough information to let you identify the referred resource.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		API version of the referent
kind
string		Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds&#34;
name
string		Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+
+

DaemonSet v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DaemonSet
+ + + +

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
DaemonSetSpec		The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
DaemonSetStatus		The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

DaemonSetSpec v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		The minimum number of seconds for which a newly created DaemonSet 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).
revisionHistoryLimit
integer		The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector		A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		An 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: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
updateStrategy
DaemonSetUpdateStrategy		An update strategy to replace existing DaemonSet pods with new pods.
+

DaemonSetStatus v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer		Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
DaemonSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer		The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer		The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer		The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer		The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer		The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer		The total number of nodes that are running updated daemon pod
+

DaemonSetList v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
DaemonSet array		A list of daemon sets.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

RollingUpdateDaemonSet v1beta2 apps

+ + + + + + + + + + + + + + + +
FieldDescription
maxUnavailableThe maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets
+
+
+

Output

+
+

+daemonset "daemonset-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "DaemonSet",
+  "apiVersion": "extensions/v1beta1",
+  "metadata": {
+    "name": "daemonset-example",
+    "namespace": "default",
+    "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+    "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+    "resourceVersion": "3558",
+    "generation": 1,
+    "creationTimestamp": "2016-11-22T18:35:09Z",
+    "labels": {
+      "app": "daemonset-example"
+    }
+  },
+  "spec": {
+    "selector": {
+      "matchLabels": {
+        "app": "daemonset-example"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "daemonset-example"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "daemonset-example",
+            "image": "ubuntu:trusty",
+            "command": [
+              "/bin/sh"
+            ],
+            "args": [
+              "-c",
+              "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    }
+  },
+  "status": {
+    "currentNumberScheduled": 0,
+    "numberMisscheduled": 0,
+    "desiredNumberScheduled": 0
+  }
+}
+
+

create a DaemonSet

+

HTTP Request

+

POST /apis/apps/v1beta2/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
DaemonSet		Accepted
200
DaemonSet		OK
201
DaemonSet		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified DaemonSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified DaemonSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
201
DaemonSet		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete daemonset daemonset-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets/daemonset-example'
+
+
+

Output

+
+

+daemonset "daemonset-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a DaemonSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of DaemonSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get daemonset daemonset-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/daemonsets/daemonset-example
+
+
+

Output

+
+

+
+
+

Response Body

+
+

+
+

read the specified DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified DaemonSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified DaemonSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
201
DaemonSet		Created
+
+

DaemonSet v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DaemonSet
+ + + +

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
DaemonSetSpec		The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
DaemonSetStatus		The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

DaemonSetSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		The minimum number of seconds for which a newly created DaemonSet 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).
revisionHistoryLimit
integer		The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector		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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		An 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: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
templateGeneration
integer		DEPRECATED. A sequence number representing a specific generation of the template. Populated by the system. It can be set only during the creation.
updateStrategy
DaemonSetUpdateStrategy		An update strategy to replace existing DaemonSet pods with new pods.
+

DaemonSetStatus v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer		Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
DaemonSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer		The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer		The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer		The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer		The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer		The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer		The total number of nodes that are running updated daemon pod
+

DaemonSetList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
DaemonSet array		A list of daemon sets.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

RollingUpdateDaemonSet v1beta1 extensions

+ + + + + + + + + + + + + + + +
FieldDescription
maxUnavailableThe maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  template:
+    metadata:
+      labels:
+        app: daemonset-example
+    spec:
+      containers:
+      - name: daemonset-example
+        image: ubuntu:trusty
+        command:
+        - /bin/sh
+        args:
+        - -c
+        - >-
+          while [ true ]; do
+          echo "DaemonSet running on $(hostname)" ;
+          sleep 10 ;
+          done
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets
+
+
+

Output

+
+

+daemonset "daemonset-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "DaemonSet",
+  "apiVersion": "extensions/v1beta1",
+  "metadata": {
+    "name": "daemonset-example",
+    "namespace": "default",
+    "selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
+    "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
+    "resourceVersion": "3558",
+    "generation": 1,
+    "creationTimestamp": "2016-11-22T18:35:09Z",
+    "labels": {
+      "app": "daemonset-example"
+    }
+  },
+  "spec": {
+    "selector": {
+      "matchLabels": {
+        "app": "daemonset-example"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "daemonset-example"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "daemonset-example",
+            "image": "ubuntu:trusty",
+            "command": [
+              "/bin/sh"
+            ],
+            "args": [
+              "-c",
+              "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    }
+  },
+  "status": {
+    "currentNumberScheduled": 0,
+    "numberMisscheduled": 0,
+    "desiredNumberScheduled": 0
+  }
+}
+
+

create a DaemonSet

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
201
DaemonSet		Created
202
DaemonSet		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified DaemonSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified DaemonSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
201
DaemonSet		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete daemonset daemonset-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example'
+
+
+

Output

+
+

+daemonset "daemonset-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a DaemonSet

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of DaemonSet

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get daemonset daemonset-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example
+
+
+

Output

+
+

+
+
+

Response Body

+
+

+
+

read the specified DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified DaemonSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified DaemonSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
201
DaemonSet		Created
+
+

DaemonSetCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DaemonSetCondition
+ + + +

DaemonSetCondition describes the state of a DaemonSet at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of DaemonSet condition.
+
+

DaemonSetCondition v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DaemonSetCondition
+ + + +

DaemonSetCondition describes the state of a DaemonSet at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of DaemonSet condition.
+
+

DaemonSetUpdateStrategy v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DaemonSetUpdateStrategy
+ + + +

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDaemonSet		Rolling update config params. Present only if type = "RollingUpdate".
type
string		Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
+
+

DaemonSetUpdateStrategy v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DaemonSetUpdateStrategy
+ + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDaemonSet		Rolling update config params. Present only if type = "RollingUpdate".
type
string		Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is OnDelete.
+
+

Deployment v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2Deployment
+ + + +

DEPRECATED - This group version of Deployment is deprecated by apps/v1/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean		Indicates that the deployment is paused.
progressDeadlineSeconds
integer		The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
replicas
integer		Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit
integer		The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector		Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
strategy
DeploymentStrategy		The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec		Template describes the pods that will be created.
+

DeploymentStatus v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
collisionCount
integer		Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
conditions
DeploymentCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Deployment array		Items is the list of Deployments.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1beta2 apps

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDeployment		Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type
string		Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+

RollingUpdateDeployment v1beta2 apps

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
maxSurgeThe maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
maxUnavailableThe maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments
+
+
+

Output

+
+

+deployment "deployment-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2118306",
+    "generation": 1,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {}
+}
+
+

create a Deployment

+

HTTP Request

+

POST /apis/apps/v1beta2/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
Deployment		Accepted
200
Deployment		OK
201
Deployment		Created
+

Patch

+
+

kubectl Command

+
+

+$ kubectl patch deployment deployment-example -p \
+    '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+    "resourceVersion": "164489",
+    "generation": 11,
+    "creationTimestamp": "2016-11-22T20:00:50Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "5"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 10,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

partially update the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' | kubectl replace -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+deployment "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2119082",
+    "generation": 5,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

replace the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete deployment deployment-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+deployment "deployment-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a Deployment

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Deployment

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

read the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

List

+
+

kubectl Command

+
+

+$ kubectl get deployment -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments'
+
+
+

Output

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+
+

Response Body

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

Watch

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example --watch -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta2/watch/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+
+

Response Body

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+

watch changes to an object of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Deployment		Created
200
Deployment		OK
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Scale		Created
200
Scale		OK
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

Deployment v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1Deployment
+ + + +

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean		Indicates that the deployment is paused.
progressDeadlineSeconds
integer		The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
replicas
integer		Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit
integer		The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2.
rollbackTo
RollbackConfig		DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.
selector
LabelSelector		Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
strategy
DeploymentStrategy		The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec		Template describes the pods that will be created.
+

DeploymentStatus v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
collisionCount
integer		Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
conditions
DeploymentCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Deployment array		Items is the list of Deployments.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1beta1 apps

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDeployment		Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type
string		Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+

DeploymentRollback v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string		Required: This must match the Name of a deployment.
rollbackTo
RollbackConfig		The config of this deployment rollback.
updatedAnnotations
object		The annotations to be updated to a deployment
+

RollingUpdateDeployment v1beta1 apps

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
maxSurgeThe maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
maxUnavailableThe maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments
+
+
+

Output

+
+

+deployment "deployment-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2118306",
+    "generation": 1,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {}
+}
+
+

create a Deployment

+

HTTP Request

+

POST /apis/apps/v1beta1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
202
Deployment		Accepted
+

Patch

+
+

kubectl Command

+
+

+$ kubectl patch deployment deployment-example -p \
+    '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+    "resourceVersion": "164489",
+    "generation": 11,
+    "creationTimestamp": "2016-11-22T20:00:50Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "5"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 10,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

partially update the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' | kubectl replace -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+deployment "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2119082",
+    "generation": 5,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

replace the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete deployment deployment-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+deployment "deployment-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a Deployment

+

HTTP Request

+

DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Deployment

+

HTTP Request

+

DELETE /apis/apps/v1beta1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

read the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

List

+
+

kubectl Command

+
+

+$ kubectl get deployment -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments'
+
+
+

Output

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+
+

Response Body

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

Watch

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example --watch -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+
+

Response Body

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+

watch changes to an object of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Scale		Created
200
Scale		OK
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Rollback

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create rollback of a Deployment

+

HTTP Request

+

POST /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/rollback

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DeploymentRollback
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeploymentRollback
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
DeploymentRollback		Created
202
DeploymentRollback		Accepted
200
DeploymentRollback		OK
+
+

Deployment v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1Deployment
+ + + +

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean		Indicates that the deployment is paused and will not be processed by the deployment controller.
progressDeadlineSeconds
integer		The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
replicas
integer		Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit
integer		The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
rollbackTo
RollbackConfig		DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.
selector
LabelSelector		Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
strategy
DeploymentStrategy
patch type: retainKeys		The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec		Template describes the pods that will be created.
+

DeploymentStatus v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
collisionCount
integer		Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
conditions
DeploymentCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Deployment array		Items is the list of Deployments.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDeployment		Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type
string		Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+

DeploymentRollback v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string		Required: This must match the Name of a deployment.
rollbackTo
RollbackConfig		The config of this deployment rollback.
updatedAnnotations
object		The annotations to be updated to a deployment
+

RollingUpdateDeployment v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
maxSurgeThe maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.
maxUnavailableThe maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' | kubectl create -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X POST -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments
+
+
+

Output

+
+

+deployment "deployment-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2118306",
+    "generation": 1,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {}
+}
+
+

create a Deployment

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
202
Deployment		Accepted
+

Patch

+
+

kubectl Command

+
+

+$ kubectl patch deployment deployment-example -p \
+    '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
+{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
+    "resourceVersion": "164489",
+    "generation": 11,
+    "creationTimestamp": "2016-11-22T20:00:50Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "5"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 10,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

partially update the specified Deployment

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' | kubectl replace -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+deployment "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
+    "resourceVersion": "2119082",
+    "generation": 5,
+    "creationTimestamp": "2016-10-28T01:53:19Z",
+    "labels": {
+      "app": "nginx"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.11",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    },
+    "revisionHistoryLimit": 10
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

replace the specified Deployment

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
+

Delete

+
+

kubectl Command

+
+

+$ kubectl delete deployment deployment-example
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+deployment "deployment-example" deleted
+
+
+

Response Body

+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+

delete a Deployment

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Deployment

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+    "resourceVersion": "2064726",
+    "generation": 4,
+    "creationTimestamp": "2016-10-27T16:33:35Z",
+    "labels": {
+      "app": "nginx"
+    },
+    "annotations": {
+      "deployment.kubernetes.io/revision": "1"
+    }
+  },
+  "spec": {
+    "replicas": 3,
+    "selector": {
+      "matchLabels": {
+        "app": "nginx"
+      }
+    },
+    "template": {
+      "metadata": {
+        "creationTimestamp": null,
+        "labels": {
+          "app": "nginx"
+        }
+      },
+      "spec": {
+        "containers": [
+          {
+            "name": "nginx",
+            "image": "nginx:1.10",
+            "ports": [
+              {
+                "containerPort": 80,
+                "protocol": "TCP"
+              }
+            ],
+            "resources": {},
+            "terminationMessagePath": "/dev/termination-log",
+            "imagePullPolicy": "IfNotPresent"
+          }
+        ],
+        "restartPolicy": "Always",
+        "terminationGracePeriodSeconds": 30,
+        "dnsPolicy": "ClusterFirst",
+        "securityContext": {}
+      }
+    },
+    "strategy": {
+      "type": "RollingUpdate",
+      "rollingUpdate": {
+        "maxUnavailable": 1,
+        "maxSurge": 1
+      }
+    }
+  },
+  "status": {
+    "observedGeneration": 4,
+    "replicas": 3,
+    "updatedReplicas": 3,
+    "availableReplicas": 3
+  }
+}
+
+

read the specified Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

List

+
+

kubectl Command

+
+

+$ kubectl get deployment -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments'
+
+
+

Output

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+
+

Response Body

+
+

+{
+  "kind": "List",
+  "apiVersion": "v1",
+  "metadata": {},
+  "items": [
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "docs",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
+        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
+        "resourceVersion": "1924126",
+        "generation": 21,
+        "creationTimestamp": "2016-10-13T16:06:00Z",
+        "labels": {
+          "run": "docs"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "10",
+          "replicatingperfection.net/push-image": "true"
+        }
+      },
+      "spec": {
+        "replicas": 1,
+        "selector": {
+          "matchLabels": {
+            "run": "docs"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "auto-pushed-image-pwittrock/api-docs": "1477496453",
+              "run": "docs"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "docs",
+                "image": "pwittrock/api-docs:v9",
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "Always"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 21,
+        "replicas": 1,
+        "updatedReplicas": 1,
+        "availableReplicas": 1
+      }
+    },
+    {
+      "kind": "Deployment",
+      "apiVersion": "app/v1beta1",
+      "metadata": {
+        "name": "deployment-example",
+        "namespace": "default",
+        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
+        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
+        "resourceVersion": "2064726",
+        "generation": 4,
+        "creationTimestamp": "2016-10-27T16:33:35Z",
+        "labels": {
+          "app": "nginx"
+        },
+        "annotations": {
+          "deployment.kubernetes.io/revision": "1"
+        }
+      },
+      "spec": {
+        "replicas": 3,
+        "selector": {
+          "matchLabels": {
+            "app": "nginx"
+          }
+        },
+        "template": {
+          "metadata": {
+            "creationTimestamp": null,
+            "labels": {
+              "app": "nginx"
+            }
+          },
+          "spec": {
+            "containers": [
+              {
+                "name": "nginx",
+                "image": "nginx:1.10",
+                "ports": [
+                  {
+                    "containerPort": 80,
+                    "protocol": "TCP"
+                  }
+                ],
+                "resources": {},
+                "terminationMessagePath": "/dev/termination-log",
+                "imagePullPolicy": "IfNotPresent"
+              }
+            ],
+            "restartPolicy": "Always",
+            "terminationGracePeriodSeconds": 30,
+            "dnsPolicy": "ClusterFirst",
+            "securityContext": {}
+          }
+        },
+        "strategy": {
+          "type": "RollingUpdate",
+          "rollingUpdate": {
+            "maxUnavailable": 1,
+            "maxSurge": 1
+          }
+        }
+      },
+      "status": {
+        "observedGeneration": 4,
+        "replicas": 3,
+        "updatedReplicas": 3,
+        "availableReplicas": 3
+      }
+    }
+  ]
+}
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DeploymentList		OK
+

Watch

+
+

kubectl Command

+
+

+$ kubectl get deployment deployment-example --watch -o json
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X GET 'http://127.0.0.1:8001/apis/extensions/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+
+

Response Body

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/namespaces/default/deployments/deployment-example",
+            "uid": "64c12290-9cbf-11e6-9c54-42010a800148",
+            "resourceVersion": "2128095",
+            "generation": 2,
+            "creationTimestamp": "2016-10-28T03:34:12Z",
+            "labels": {
+                "app": "nginx"
+            },
+            "annotations": {
+                "deployment.kubernetes.io/revision": "3"
+            }
+        },
+        "spec": {
+            "replicas": 3,
+            "selector": {
+                "matchLabels": {
+                    "app": "nginx"
+                }
+            },
+            "template": {
+                "metadata": {
+                    "creationTimestamp": null,
+                    "labels": {
+                        "app": "nginx"
+                    }
+                },
+                "spec": {
+                    "containers": [
+                        {
+                            "name": "nginx",
+                            "image": "nginx:1.10",
+                            "ports": [
+                                {
+                                    "containerPort": 80,
+                                    "protocol": "TCP"
+                                }
+                            ],
+                            "resources": {
+                            },
+                            "terminationMessagePath": "/dev/termination-log",
+                            "imagePullPolicy": "IfNotPresent"
+                        }
+                    ],
+                    "restartPolicy": "Always",
+                    "terminationGracePeriodSeconds": 30,
+                    "dnsPolicy": "ClusterFirst",
+                    "securityContext": {
+                    }
+                }
+            },
+            "strategy": {
+                "type": "RollingUpdate",
+                "rollingUpdate": {
+                    "maxUnavailable": 1,
+                    "maxSurge": 1
+                }
+            }
+        },
+        "status": {
+            "observedGeneration": 2,
+            "replicas": 3,
+            "updatedReplicas": 3,
+            "availableReplicas": 3
+        }
+    }
+}
+
+

watch changes to an object of kind Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Deployment

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Deployment

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
201
Deployment		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified Deployment

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified Deployment

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Rollback

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create rollback of a Deployment

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DeploymentRollback
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeploymentRollback
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
DeploymentRollback		Created
202
DeploymentRollback		Accepted
200
DeploymentRollback		OK
+
+

DeploymentCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DeploymentCondition
+ + + +

DeploymentCondition describes the state of a deployment at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
lastUpdateTime
Time		The last time this condition was updated.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of deployment condition.
+
+

DeploymentCondition v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1DeploymentCondition
+ + + +

DeploymentCondition describes the state of a deployment at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
lastUpdateTime
Time		The last time this condition was updated.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of deployment condition.
+
+

DeploymentCondition v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DeploymentCondition
+ + + +

DeploymentCondition describes the state of a deployment at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
lastUpdateTime
Time		The last time this condition was updated.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of deployment condition.
+
+

Event v1beta1 events.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
events.k8s.iov1beta1Event
+ + + +

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
action
string		What action was taken/failed regarding to the regarding object.
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
deprecatedCount
integer		Deprecated field assuring backward compatibility with core.v1 Event type
deprecatedFirstTimestamp
Time		Deprecated field assuring backward compatibility with core.v1 Event type
deprecatedLastTimestamp
Time		Deprecated field assuring backward compatibility with core.v1 Event type
deprecatedSource
EventSource		Deprecated field assuring backward compatibility with core.v1 Event type
eventTime
MicroTime		Required. Time when this Event was first observed.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
note
string		Optional. A human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
reason
string		Why the action was taken.
regarding
ObjectReference		The object this Event is about. In most cases it's an Object reporting controller implements. E.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
related
ObjectReference		Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
reportingController
string		Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
reportingInstance
string		ID of the controller instance, e.g. kubelet-xyzf.
series
EventSeries		Data about the Event series this event represents or nil if it's a singleton Event.
type
string		Type of this event (Normal, Warning), new types could be added in the future.
+

EventList v1beta1 events

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Event array		Items is a list of schema objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an Event

+

HTTP Request

+

POST /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Event		OK
201
Event		Created
202
Event		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Event

+

HTTP Request

+

PATCH /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Event

+

HTTP Request

+

PUT /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Event		Created
200
Event		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an Event

+

HTTP Request

+

DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Event

+

HTTP Request

+

DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
EventList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
EventList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/watch/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

EventSeries v1beta1 events.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
events.k8s.iov1beta1EventSeries
+ + + +

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
count
integer		Number of occurrences in this series up to the last heartbeat time
lastObservedTime
MicroTime		Time when last Event from the series was seen before last heartbeat.
state
string		Information whether this series is ongoing or finished.
+
+

FSGroupStrategyOptions v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1FSGroupStrategyOptions
+

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ranges
IDRange array		ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs.
rule
string		rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
+
+

HorizontalPodAutoscaler v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1HorizontalPodAutoscaler
+ + + +

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
HorizontalPodAutoscalerSpec		spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
HorizontalPodAutoscalerStatus		status is the current information about the autoscaler.
+

HorizontalPodAutoscalerSpec v2beta1 autoscaling

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
maxReplicas
integer		maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
metrics
MetricSpec array		metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond.
minReplicas
integer		minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.
scaleTargetRef
CrossVersionObjectReference		scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
+

HorizontalPodAutoscalerStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
conditions
HorizontalPodAutoscalerCondition array		conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
currentMetrics
MetricStatus array		currentMetrics is the last read state of the metrics used by this autoscaler.
currentReplicas
integer		currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
desiredReplicas
integer		desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
lastScaleTime
Time		lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
observedGeneration
integer		observedGeneration is the most recent generation observed by this autoscaler.
+

HorizontalPodAutoscalerList v2beta1 autoscaling

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
HorizontalPodAutoscaler array		items is the list of horizontal pod autoscaler objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		metadata is the standard list metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a HorizontalPodAutoscaler

+

HTTP Request

+

POST /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
HorizontalPodAutoscaler		Created
202
HorizontalPodAutoscaler		Accepted
200
HorizontalPodAutoscaler		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified HorizontalPodAutoscaler

+

HTTP Request

+

PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified HorizontalPodAutoscaler

+

HTTP Request

+

PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
HorizontalPodAutoscaler		Created
200
HorizontalPodAutoscaler		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a HorizontalPodAutoscaler

+

HTTP Request

+

DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of HorizontalPodAutoscaler

+

HTTP Request

+

DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscalerList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscalerList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified HorizontalPodAutoscaler

+

HTTP Request

+

PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified HorizontalPodAutoscaler

+

HTTP Request

+

PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
201
HorizontalPodAutoscaler		Created
+
+

HostPortRange v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1HostPortRange
+

HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
max
integer		max is the end of the range, inclusive.
min
integer		min is the start of the range, inclusive.
+
+

IDRange v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1IDRange
+

IDRange provides a min/max of an allowed range of IDs.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
max
integer		max is the end of the range, inclusive.
min
integer		min is the start of the range, inclusive.
+
+

IPBlock v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IPBlock
+ + + +

DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
cidr
string		CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"
except
string array		Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range
+
+

Initializer v1alpha1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1alpha1Initializer
+ + + +

Initializer describes the name and the failure policy of an initializer, and what resources it applies to.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the identifier of the initializer. It will be added to the object that needs to be initialized. Name should be fully qualified, e.g., alwayspullimages.kubernetes.io, where "alwayspullimages" is the name of the webhook, and kubernetes.io is the name of the organization. Required
rules
Rule array		Rules describes what resources/subresources the initializer cares about. The initializer cares about an operation if it matches any Rule. Rule.Resources must not include subresources.
+
+

JobTemplateSpec v2alpha1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv2alpha1JobTemplateSpec
+ + + +

JobTemplateSpec describes the data a Job should have when created from a template

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
metadata
ObjectMeta		Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
JobSpec		Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+
+

LocalSubjectAccessReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1LocalSubjectAccessReview
+ + + +

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a LocalSubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
LocalSubjectAccessReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
LocalSubjectAccessReview		OK
201
LocalSubjectAccessReview		Created
202
LocalSubjectAccessReview		Accepted
+
+

NetworkPolicy v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicy
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NetworkPolicySpec		Specification of the desired behavior for this NetworkPolicy.
+

NetworkPolicySpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
egress
NetworkPolicyEgressRule array		List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
ingress
NetworkPolicyIngressRule array		List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default).
podSelector
LabelSelector		Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
policyTypes
string array		List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
+

NetworkPolicyList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
NetworkPolicy array		Items is a list of schema objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a NetworkPolicy

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
201
NetworkPolicy		Created
202
NetworkPolicy		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified NetworkPolicy

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified NetworkPolicy

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
201
NetworkPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a NetworkPolicy

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of NetworkPolicy

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicyList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicyList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

NetworkPolicyEgressRule v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyEgressRule
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule. NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ports
NetworkPolicyPort array		List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
to
NetworkPolicyPeer array		List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
+
+

NetworkPolicyIngressRule v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyIngressRule
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
from
NetworkPolicyPeer array		List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.
ports
NetworkPolicyPort array		List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
+
+

NetworkPolicyPeer v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyPeer
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
ipBlock
IPBlock		IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
namespaceSelector
LabelSelector		Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
podSelector
LabelSelector		This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
+
+

NetworkPolicyPort v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyPort
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
portIf specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
protocol
string		Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.
+
+

NonResourceAttributes v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1NonResourceAttributes
+ + + +

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
path
string		Path is the URL path of the request
verb
string		Verb is the standard HTTP verb
+
+

NonResourceRule v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1NonResourceRule
+ + + +

NonResourceRule holds information that describes a rule for the non-resource

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
nonResourceURLs
string array		NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
verbs
string array		Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
+
+

PodSecurityPolicy v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1PodSecurityPolicy
+

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PodSecurityPolicySpec		spec defines the policy enforced.
+

PodSecurityPolicySpec v1beta1 policy

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowPrivilegeEscalation
boolean		allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
allowedCapabilities
string array		allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities.
allowedFlexVolumes
AllowedFlexVolume array		allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field.
allowedHostPaths
AllowedHostPath array		allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used.
allowedUnsafeSysctls
string array		allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of allowed sysctls. Single means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/" allows "foo/bar", "foo/baz", etc. e.g. "foo." allows "foo.bar", "foo.baz", etc.
defaultAddCapabilities
string array		defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list.
defaultAllowPrivilegeEscalation
boolean		defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
forbiddenSysctls
string array		forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of forbidden sysctls. Single means all sysctls are forbidden. Examples: e.g. "foo/" forbids "foo/bar", "foo/baz", etc. e.g. "foo." forbids "foo.bar", "foo.baz", etc.
fsGroup
FSGroupStrategyOptions		fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.
hostIPC
boolean		hostIPC determines if the policy allows the use of HostIPC in the pod spec.
hostNetwork
boolean		hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
hostPID
boolean		hostPID determines if the policy allows the use of HostPID in the pod spec.
hostPorts
HostPortRange array		hostPorts determines which host port ranges are allowed to be exposed.
privileged
boolean		privileged determines if a pod can request to be run as privileged.
readOnlyRootFilesystem
boolean		readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
requiredDropCapabilities
string array		requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
runAsUser
RunAsUserStrategyOptions		runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
seLinux
SELinuxStrategyOptions		seLinux is the strategy that will dictate the allowable labels that may be set.
supplementalGroups
SupplementalGroupsStrategyOptions		supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
volumes
string array		volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'.
+

PodSecurityPolicyList v1beta1 policy

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PodSecurityPolicy array		items is a list of schema objects.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodSecurityPolicy

+

HTTP Request

+

POST /apis/policy/v1beta1/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
PodSecurityPolicy		Created
202
PodSecurityPolicy		Accepted
200
PodSecurityPolicy		OK
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PodSecurityPolicy

+

HTTP Request

+

PATCH /apis/policy/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PodSecurityPolicy

+

HTTP Request

+

PUT /apis/policy/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
201
PodSecurityPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PodSecurityPolicy

+

HTTP Request

+

DELETE /apis/policy/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PodSecurityPolicy

+

HTTP Request

+

DELETE /apis/policy/v1beta1/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PodSecurityPolicy

+

HTTP Request

+

GET /apis/policy/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodSecurityPolicy

+

HTTP Request

+

GET /apis/policy/v1beta1/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicyList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodSecurityPolicy

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodSecurityPolicy

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PolicyRule v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1PolicyRule
+ + + +

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array		NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array		Resources is a list of resources this rule applies to. '*' represents all resources in the specified apiGroups. '*/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
verbs
string array		Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+
+

PolicyRule v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1PolicyRule
+ + + +

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array		NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array		Resources is a list of resources this rule applies to. ResourceAll represents all resources.
verbs
string array		Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+
+

PriorityClass v1alpha1 scheduling.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
scheduling.k8s.iov1alpha1PriorityClass
+ + + +

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
description
string		description is an arbitrary string that usually provides guidelines on when this priority class should be used.
globalDefault
boolean		globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as globalDefault. However, if more than one PriorityClasses exists with their globalDefault field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
value
integer		The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
+

PriorityClassList v1alpha1 scheduling

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PriorityClass array		items is the list of PriorityClasses
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PriorityClass

+

HTTP Request

+

POST /apis/scheduling.k8s.io/v1alpha1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
201
PriorityClass		Created
202
PriorityClass		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PriorityClass

+

HTTP Request

+

PATCH /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PriorityClass

+

HTTP Request

+

PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
201
PriorityClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClassList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ReplicaSet v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2ReplicaSet
+ + + +

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ReplicaSetSpec		Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
ReplicaSetStatus		Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

ReplicaSetSpec v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer		Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
selector
LabelSelector		Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
+

ReplicaSetStatus v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		The number of available replicas (ready for at least minReadySeconds) for this replica set.
conditions
ReplicaSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a replica set's current state.
fullyLabeledReplicas
integer		The number of pods that have labels matching the labels of the pod template of the replicaset.
observedGeneration
integer		ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
readyReplicas
integer		The number of ready replicas for this replica set.
replicas
integer		Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
+

ReplicaSetList v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ReplicaSet array		List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ReplicaSet

+

HTTP Request

+

POST /apis/apps/v1beta2/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
201
ReplicaSet		Created
202
ReplicaSet		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
201
ReplicaSet		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ReplicaSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ReplicaSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
201
ReplicaSet		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

ReplicaSet v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1ReplicaSet
+ + + +

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ReplicaSetSpec		Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
ReplicaSetStatus		Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

ReplicaSetSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer		Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer		Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
selector
LabelSelector		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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec		Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
+

ReplicaSetStatus v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		The number of available replicas (ready for at least minReadySeconds) for this replica set.
conditions
ReplicaSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a replica set's current state.
fullyLabeledReplicas
integer		The number of pods that have labels matching the labels of the pod template of the replicaset.
observedGeneration
integer		ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
readyReplicas
integer		The number of ready replicas for this replica set.
replicas
integer		Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
+

ReplicaSetList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
ReplicaSet array		List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ReplicaSet

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
ReplicaSet		Accepted
200
ReplicaSet		OK
201
ReplicaSet		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ReplicaSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
201
ReplicaSet		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ReplicaSet

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ReplicaSet

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ReplicaSet		Created
200
ReplicaSet		OK
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

ReplicaSetCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2ReplicaSetCondition
+ + + +

ReplicaSetCondition describes the state of a replica set at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		The last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of replica set condition.
+
+

ReplicaSetCondition v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1ReplicaSetCondition
+ + + +

ReplicaSetCondition describes the state of a replica set at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		The last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of replica set condition.
+
+

ResourceAttributes v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1ResourceAttributes
+ + + +

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
group
string		Group is the API Group of the Resource. "*" means all.
name
string		Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
namespace
string		Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
resource
string		Resource is one of the existing resource types. "*" means all.
subresource
string		Subresource is one of the existing resource types. "" means none.
verb
string		Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
version
string		Version is the API Version of the Resource. "*" means all.
+
+

ResourceRule v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1ResourceRule
+ + + +

ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
resources
string array		Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
verbs
string array		Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
+
+

Role v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1Role
+ + + +

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this Role
+

RoleList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Role array		Items is a list of Roles
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Role

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
Role		Accepted
200
Role		OK
201
Role		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Role

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Role

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

Role v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1Role
+ + + +

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this Role
+

RoleList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Role array		Items is a list of Roles
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Role

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
202
Role		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Role

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Role

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

RoleBinding v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1RoleBinding
+ + + +

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

RoleBindingList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
RoleBinding array		Items is a list of RoleBindings
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a RoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
202
RoleBinding		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified RoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified RoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBindingList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBindingList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

RoleBinding v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1RoleBinding
+ + + +

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

RoleBindingList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
RoleBinding array		Items is a list of RoleBindings
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a RoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
RoleBinding		Accepted
200
RoleBinding		OK
201
RoleBinding		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified RoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified RoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBindingList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBindingList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

RoleRef v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1RoleRef
+ + + +

RoleRef contains information that points to the role being used

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroup
string		APIGroup is the group for the resource being referenced
kind
string		Kind is the type of resource being referenced
name
string		Name is the name of resource being referenced
+
+

RoleRef v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1RoleRef
+ + + +

RoleRef contains information that points to the role being used

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroup
string		APIGroup is the group for the resource being referenced
kind
string		Kind is the type of resource being referenced
name
string		Name is the name of resource being referenced
+
+

RollbackConfig v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1RollbackConfig
+

DEPRECATED.

+ + + + + + + + + + + + + + + +
FieldDescription
revision
integer		The revision to rollback to. If set to 0, rollback to the last revision.
+
+

RollingUpdateStatefulSetStrategy v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2RollingUpdateStatefulSetStrategy
+ + + +

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

+ + + + + + + + + + + + + + + +
FieldDescription
partition
integer		Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
+
+

RollingUpdateStatefulSetStrategy v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1RollingUpdateStatefulSetStrategy
+ + + +

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

+ + + + + + + + + + + + + + + +
FieldDescription
partition
integer		Partition indicates the ordinal at which the StatefulSet should be partitioned.
+
+

RunAsUserStrategyOptions v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1RunAsUserStrategyOptions
+

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ranges
IDRange array		ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs.
rule
string		rule is the strategy that will dictate the allowable RunAsUser values that may be set.
+
+

SELinuxStrategyOptions v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1SELinuxStrategyOptions
+

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rule
string		rule is the strategy that will dictate the allowable labels that may be set.
seLinuxOptions
SELinuxOptions		seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+
+

Scale v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2Scale
+ + + +

Scale represents a scaling request for a resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleSpec v1beta2 apps

+ + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		desired number of instances for the scaled object.
+

ScaleStatus v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		actual number of observed instances of the scaled object.
selector
object		label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
targetSelector
string		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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
+

Scale v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1Scale
+ + + +

Scale represents a scaling request for a resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleSpec v1beta1 apps

+ + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		desired number of instances for the scaled object.
+

ScaleStatus v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		actual number of observed instances of the scaled object.
selector
object		label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
targetSelector
string		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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
+

Scale v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1Scale
+ + + +

represents a scaling request for a resource.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleSpec v1beta1 extensions

+ + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		desired number of instances for the scaled object.
+

ScaleStatus v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		actual number of observed instances of the scaled object.
selector
object		label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
targetSelector
string		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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
+

SelfSubjectAccessReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SelfSubjectAccessReview
+ + + +

SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectAccessReviewSpec		Spec holds information about the request being evaluated. user and groups must be empty
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SelfSubjectAccessReviewSpec v1beta1 authorization

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SelfSubjectAccessReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
SelfSubjectAccessReview		Accepted
200
SelfSubjectAccessReview		OK
201
SelfSubjectAccessReview		Created
+
+

SelfSubjectRulesReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SelfSubjectRulesReview
+ + + +

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectRulesReviewSpec		Spec holds information about the request being evaluated.
status
SubjectRulesReviewStatus		Status is filled in by the server and indicates the set of actions a user can perform.
+

SelfSubjectRulesReviewSpec v1beta1 authorization

+ + + + + + + + + + + + + + + +
FieldDescription
namespace
string		Namespace to evaluate rules for. Required.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectRulesReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SelfSubjectRulesReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
201
SelfSubjectRulesReview		Created
202
SelfSubjectRulesReview		Accepted
200
SelfSubjectRulesReview		OK
+
+

ServiceReference v1beta1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1ServiceReference
+ + + +

ServiceReference holds a reference to Service.legacy.k8s.io

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		name is the name of the service. Required
namespace
string		namespace is the namespace of the service. Required
path
string		path is an optional URL path which will be sent in any request to this service.
+
+

ServiceReference v1beta1 apiregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1ServiceReference
+ + + +

ServiceReference holds a reference to Service.legacy.k8s.io

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the name of the service
namespace
string		Namespace is the namespace of the service
+
+

StatefulSet v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2StatefulSet
+ + + +

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

+
    +
  • Network: A single stable DNS and hostname.
    • +
  • Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity.
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
StatefulSetSpec		Spec defines the desired identities of pods in this set.
status
StatefulSetStatus		Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+

StatefulSetSpec v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string		podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer		replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer		revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector		selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
serviceName
string		serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec		template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy
StatefulSetUpdateStrategy		updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
volumeClaimTemplates
PersistentVolumeClaim array		volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+

StatefulSetStatus v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer		collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
StatefulSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a statefulset's current state.
currentReplicas
integer		currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
currentRevision
string		currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
observedGeneration
integer		observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
readyReplicas
integer		readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
replicas
integer		replicas is the number of Pods created by the StatefulSet controller.
updateRevision
string		updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
updatedReplicas
integer		updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
+

StatefulSetList v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
StatefulSet array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StatefulSet

+

HTTP Request

+

POST /apis/apps/v1beta2/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
202
StatefulSet		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

StatefulSet v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1StatefulSet
+ + + +

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

+
    +
  • Network: A single stable DNS and hostname.
    • +
  • Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity.
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
StatefulSetSpec		Spec defines the desired identities of pods in this set.
status
StatefulSetStatus		Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+

StatefulSetSpec v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string		podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer		replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer		revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector		selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
serviceName
string		serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec		template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy
StatefulSetUpdateStrategy		updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
volumeClaimTemplates
PersistentVolumeClaim array		volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+

StatefulSetStatus v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer		collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
StatefulSetCondition array
patch type: merge
patch merge key: type		Represents the latest available observations of a statefulset's current state.
currentReplicas
integer		currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
currentRevision
string		currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
observedGeneration
integer		observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
readyReplicas
integer		readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
replicas
integer		replicas is the number of Pods created by the StatefulSet controller.
updateRevision
string		updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
updatedReplicas
integer		updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
+

StatefulSetList v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
StatefulSet array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StatefulSet

+

HTTP Request

+

POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
202
StatefulSet		Accepted
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{name}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
201
StatefulSet		Created
+

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Replace Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
201
Scale		Created
+

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Scale
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

StatefulSetCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2StatefulSetCondition
+ + + +

StatefulSetCondition describes the state of a statefulset at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of statefulset condition.
+
+

StatefulSetCondition v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1StatefulSetCondition
+ + + +

StatefulSetCondition describes the state of a statefulset at a certain point.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of statefulset condition.
+
+

StatefulSetUpdateStrategy v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2StatefulSetUpdateStrategy
+ + + +

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateStatefulSetStrategy		RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
type
string		Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
+
+

StatefulSetUpdateStrategy v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1StatefulSetUpdateStrategy
+ + + +

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateStatefulSetStrategy		RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
type
string		Type indicates the type of the StatefulSetUpdateStrategy.
+
+

StorageClass v1beta1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1StorageClass
+ + + +

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

+

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowVolumeExpansion
boolean		AllowVolumeExpansion shows whether the storage class allow volume expand
allowedTopologies
TopologySelectorTerm array		Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is alpha-level and is only honored by servers that enable the DynamicProvisioningScheduling feature.
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
mountOptions
string array		Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
parameters
object		Parameters holds the parameters for the provisioner that should create volumes of this storage class.
provisioner
string		Provisioner indicates the type of the provisioner.
reclaimPolicy
string		Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
volumeBindingMode
string		VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is alpha-level and is only honored by servers that enable the VolumeScheduling feature.
+

StorageClassList v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
StorageClass array		Items is the list of StorageClasses
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StorageClass

+

HTTP Request

+

POST /apis/storage.k8s.io/v1beta1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
StorageClass		Accepted
200
StorageClass		OK
201
StorageClass		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StorageClass

+

HTTP Request

+

PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StorageClass

+

HTTP Request

+

PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
201
StorageClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StorageClass

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StorageClass

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClassList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

Subject v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1Subject
+ + + +

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroup
string		APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
kind
string		Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string		Name of the object being referenced.
namespace
string		Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+
+

Subject v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1Subject
+ + + +

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
kind
string		Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string		Name of the object being referenced.
namespace
string		Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+
+

SubjectAccessReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SubjectAccessReview
+ + + +

SubjectAccessReview checks whether or not a user or group can perform an action.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SubjectAccessReviewSpec v1beta1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
group
string array		Groups is the groups you're testing for.
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
uid
string		UID information about the requesting user.
user
string		User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups
+

SubjectAccessReviewStatus v1beta1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowed
boolean		Allowed is required. True if the action would be allowed, false otherwise.
denied
boolean		Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
evaluationError
string		EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
reason
string		Reason is optional. It indicates why a request was allowed or denied.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SubjectAccessReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
SubjectAccessReview		Accepted
200
SubjectAccessReview		OK
201
SubjectAccessReview		Created
+
+

SubjectRulesReviewStatus v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SubjectRulesReviewStatus
+ + + +

SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
evaluationError
string		EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
incomplete
boolean		Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
nonResourceRules
NonResourceRule array		NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
resourceRules
ResourceRule array		ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+
+

SupplementalGroupsStrategyOptions v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1SupplementalGroupsStrategyOptions
+

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
ranges
IDRange array		ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs.
rule
string		rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
+
+

TokenReview v1beta1 authentication.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authentication.k8s.iov1beta1TokenReview
+ + + +

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
TokenReviewSpec		Spec holds information about the request being evaluated
status
TokenReviewStatus		Status is filled in by the server and indicates whether the request can be authenticated.
+

TokenReviewSpec v1beta1 authentication

+ + + + + + + + + + + + + + + +
FieldDescription
token
string		Token is the opaque bearer token.
+

TokenReviewStatus v1beta1 authentication

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
authenticated
boolean		Authenticated indicates that the token was associated with a known user.
error
string		Error indicates that the token couldn't be checked
user
UserInfo		User is the UserInfo associated with the provided token.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a TokenReview

+

HTTP Request

+

POST /apis/authentication.k8s.io/v1beta1/tokenreviews

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
TokenReview
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
TokenReview		Accepted
200
TokenReview		OK
201
TokenReview		Created
+
+

UserInfo v1beta1 authentication.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authentication.k8s.iov1beta1UserInfo
+ + + +

UserInfo holds the information about the user needed to implement the user.Info interface.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Any additional information provided by the authenticator.
groups
string array		The names of groups this user is a part of.
uid
string		A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
username
string		The name that uniquely identifies this user among all active users.
+
+

VolumeAttachment v1alpha1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeAttachment
+ + + +

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

+

VolumeAttachment objects are non-namespaced.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
VolumeAttachmentSpec		Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
status
VolumeAttachmentStatus		Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
+

VolumeAttachmentSpec v1alpha1 storage

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attacher
string		Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
nodeName
string		The node that the volume should be attached to.
source
VolumeAttachmentSource		Source represents the volume that should be attached.
+

VolumeAttachmentStatus v1alpha1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attachError
VolumeError		The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attached
boolean		Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attachmentMetadata
object		Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
detachError
VolumeError		The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
+

VolumeAttachmentList v1alpha1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
VolumeAttachment array		Items is the list of VolumeAttachments
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a VolumeAttachment

+

HTTP Request

+

POST /apis/storage.k8s.io/v1alpha1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
202
VolumeAttachment		Accepted
200
VolumeAttachment		OK
201
VolumeAttachment		Created
+

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified VolumeAttachment

+

HTTP Request

+

PATCH /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified VolumeAttachment

+

HTTP Request

+

PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
201
VolumeAttachment		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe 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.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachmentList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

VolumeAttachmentSource v1alpha1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeAttachmentSource
+ + + +

VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.

+ + + + + + + + + + + + + + + +
FieldDescription
persistentVolumeName
string		Name of the persistent volume to attach.
+
+

VolumeError v1alpha1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeError
+ + + +

VolumeError captures an error encountered during a volume operation.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
message
string		String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
time
Time		Time the error was encountered.
+
+
+ + + + + + + + \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/navData.js b/static/docs/reference/generated/kubernetes-api/v1.11/navData.js new file mode 100755 index 0000000000000..1a29afefb46b5 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/navData.js @@ -0,0 +1 @@ +(function(){navData = {"toc":[{"section":"volumeerror-v1alpha1-storage-k8s-io","subsections":[]},{"section":"volumeattachmentsource-v1alpha1-storage-k8s-io","subsections":[]},{"section":"volumeattachment-v1alpha1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--1045","subsections":[{"section":"watch-list-1049"},{"section":"watch-1048"},{"section":"list-1047"},{"section":"read-1046"}]},{"section":"-strong-write-operations-strong--1039","subsections":[{"section":"delete-collection-1044"},{"section":"delete-1043"},{"section":"replace-1042"},{"section":"patch-1041"},{"section":"create-1040"}]}]},{"section":"userinfo-v1beta1-authentication-k8s-io","subsections":[]},{"section":"tokenreview-v1beta1-authentication-k8s-io","subsections":[{"section":"-strong-write-operations-strong--1037","subsections":[{"section":"create-1038"}]}]},{"section":"supplementalgroupsstrategyoptions-v1beta1-policy","subsections":[]},{"section":"subjectrulesreviewstatus-v1beta1-authorization-k8s-io","subsections":[]},{"section":"subjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--1035","subsections":[{"section":"create-1036"}]}]},{"section":"subject-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"subject-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"storageclass-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--1030","subsections":[{"section":"watch-list-1034"},{"section":"watch-1033"},{"section":"list-1032"},{"section":"read-1031"}]},{"section":"-strong-write-operations-strong--1024","subsections":[{"section":"delete-collection-1029"},{"section":"delete-1028"},{"section":"replace-1027"},{"section":"patch-1026"},{"section":"create-1025"}]}]},{"section":"statefulsetupdatestrategy-v1beta1-apps","subsections":[]},{"section":"statefulsetupdatestrategy-v1beta2-apps","subsections":[]},{"section":"statefulsetcondition-v1beta1-apps","subsections":[]},{"section":"statefulsetcondition-v1beta2-apps","subsections":[]},{"section":"statefulset-v1beta1-apps","subsections":[{"section":"-strong-misc-operations-strong--1020","subsections":[{"section":"patch-scale-1023"},{"section":"replace-scale-1022"},{"section":"read-scale-1021"}]},{"section":"-strong-status-operations-strong--1016","subsections":[{"section":"replace-status-1019"},{"section":"read-status-1018"},{"section":"patch-status-1017"}]},{"section":"-strong-read-operations-strong--1009","subsections":[{"section":"watch-list-all-namespaces-1015"},{"section":"watch-list-1014"},{"section":"watch-1013"},{"section":"list-all-namespaces-1012"},{"section":"list-1011"},{"section":"read-1010"}]},{"section":"-strong-write-operations-strong--1003","subsections":[{"section":"delete-collection-1008"},{"section":"delete-1007"},{"section":"replace-1006"},{"section":"patch-1005"},{"section":"create-1004"}]}]},{"section":"statefulset-v1beta2-apps","subsections":[{"section":"-strong-misc-operations-strong--999","subsections":[{"section":"patch-scale-1002"},{"section":"replace-scale-1001"},{"section":"read-scale-1000"}]},{"section":"-strong-status-operations-strong--995","subsections":[{"section":"replace-status-998"},{"section":"read-status-997"},{"section":"patch-status-996"}]},{"section":"-strong-read-operations-strong--988","subsections":[{"section":"watch-list-all-namespaces-994"},{"section":"watch-list-993"},{"section":"watch-992"},{"section":"list-all-namespaces-991"},{"section":"list-990"},{"section":"read-989"}]},{"section":"-strong-write-operations-strong--982","subsections":[{"section":"delete-collection-987"},{"section":"delete-986"},{"section":"replace-985"},{"section":"patch-984"},{"section":"create-983"}]}]},{"section":"servicereference-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"servicereference-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"selfsubjectrulesreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--980","subsections":[{"section":"create-981"}]}]},{"section":"selfsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--978","subsections":[{"section":"create-979"}]}]},{"section":"scale-v1beta1-extensions","subsections":[]},{"section":"scale-v1beta1-apps","subsections":[]},{"section":"scale-v1beta2-apps","subsections":[]},{"section":"selinuxstrategyoptions-v1beta1-policy","subsections":[]},{"section":"runasuserstrategyoptions-v1beta1-policy","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1beta1-apps","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1beta2-apps","subsections":[]},{"section":"rollbackconfig-v1beta1-extensions","subsections":[]},{"section":"roleref-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"roleref-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--971","subsections":[{"section":"watch-list-all-namespaces-977"},{"section":"watch-list-976"},{"section":"watch-975"},{"section":"list-all-namespaces-974"},{"section":"list-973"},{"section":"read-972"}]},{"section":"-strong-write-operations-strong--965","subsections":[{"section":"delete-collection-970"},{"section":"delete-969"},{"section":"replace-968"},{"section":"patch-967"},{"section":"create-966"}]}]},{"section":"rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--958","subsections":[{"section":"watch-list-all-namespaces-964"},{"section":"watch-list-963"},{"section":"watch-962"},{"section":"list-all-namespaces-961"},{"section":"list-960"},{"section":"read-959"}]},{"section":"-strong-write-operations-strong--952","subsections":[{"section":"delete-collection-957"},{"section":"delete-956"},{"section":"replace-955"},{"section":"patch-954"},{"section":"create-953"}]}]},{"section":"role-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--945","subsections":[{"section":"watch-list-all-namespaces-951"},{"section":"watch-list-950"},{"section":"watch-949"},{"section":"list-all-namespaces-948"},{"section":"list-947"},{"section":"read-946"}]},{"section":"-strong-write-operations-strong--939","subsections":[{"section":"delete-collection-944"},{"section":"delete-943"},{"section":"replace-942"},{"section":"patch-941"},{"section":"create-940"}]}]},{"section":"role-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--932","subsections":[{"section":"watch-list-all-namespaces-938"},{"section":"watch-list-937"},{"section":"watch-936"},{"section":"list-all-namespaces-935"},{"section":"list-934"},{"section":"read-933"}]},{"section":"-strong-write-operations-strong--926","subsections":[{"section":"delete-collection-931"},{"section":"delete-930"},{"section":"replace-929"},{"section":"patch-928"},{"section":"create-927"}]}]},{"section":"resourcerule-v1beta1-authorization-k8s-io","subsections":[]},{"section":"resourceattributes-v1beta1-authorization-k8s-io","subsections":[]},{"section":"replicasetcondition-v1beta1-extensions","subsections":[]},{"section":"replicasetcondition-v1beta2-apps","subsections":[]},{"section":"replicaset-v1beta1-extensions","subsections":[{"section":"-strong-misc-operations-strong--922","subsections":[{"section":"patch-scale-925"},{"section":"replace-scale-924"},{"section":"read-scale-923"}]},{"section":"-strong-status-operations-strong--918","subsections":[{"section":"replace-status-921"},{"section":"read-status-920"},{"section":"patch-status-919"}]},{"section":"-strong-read-operations-strong--911","subsections":[{"section":"watch-list-all-namespaces-917"},{"section":"watch-list-916"},{"section":"watch-915"},{"section":"list-all-namespaces-914"},{"section":"list-913"},{"section":"read-912"}]},{"section":"-strong-write-operations-strong--905","subsections":[{"section":"delete-collection-910"},{"section":"delete-909"},{"section":"replace-908"},{"section":"patch-907"},{"section":"create-906"}]}]},{"section":"replicaset-v1beta2-apps","subsections":[{"section":"-strong-misc-operations-strong--901","subsections":[{"section":"patch-scale-904"},{"section":"replace-scale-903"},{"section":"read-scale-902"}]},{"section":"-strong-status-operations-strong--897","subsections":[{"section":"replace-status-900"},{"section":"read-status-899"},{"section":"patch-status-898"}]},{"section":"-strong-read-operations-strong--890","subsections":[{"section":"watch-list-all-namespaces-896"},{"section":"watch-list-895"},{"section":"watch-894"},{"section":"list-all-namespaces-893"},{"section":"list-892"},{"section":"read-891"}]},{"section":"-strong-write-operations-strong--884","subsections":[{"section":"delete-collection-889"},{"section":"delete-888"},{"section":"replace-887"},{"section":"patch-886"},{"section":"create-885"}]}]},{"section":"priorityclass-v1alpha1-scheduling-k8s-io","subsections":[{"section":"-strong-read-operations-strong--879","subsections":[{"section":"watch-list-883"},{"section":"watch-882"},{"section":"list-881"},{"section":"read-880"}]},{"section":"-strong-write-operations-strong--873","subsections":[{"section":"delete-collection-878"},{"section":"delete-877"},{"section":"replace-876"},{"section":"patch-875"},{"section":"create-874"}]}]},{"section":"policyrule-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"policyrule-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"podsecuritypolicy-v1beta1-policy","subsections":[{"section":"-strong-read-operations-strong--868","subsections":[{"section":"watch-list-872"},{"section":"watch-871"},{"section":"list-870"},{"section":"read-869"}]},{"section":"-strong-write-operations-strong--862","subsections":[{"section":"delete-collection-867"},{"section":"delete-866"},{"section":"replace-865"},{"section":"patch-864"},{"section":"create-863"}]}]},{"section":"nonresourcerule-v1beta1-authorization-k8s-io","subsections":[]},{"section":"nonresourceattributes-v1beta1-authorization-k8s-io","subsections":[]},{"section":"networkpolicyport-v1beta1-extensions","subsections":[]},{"section":"networkpolicypeer-v1beta1-extensions","subsections":[]},{"section":"networkpolicyingressrule-v1beta1-extensions","subsections":[]},{"section":"networkpolicyegressrule-v1beta1-extensions","subsections":[]},{"section":"networkpolicy-v1beta1-extensions","subsections":[{"section":"-strong-read-operations-strong--855","subsections":[{"section":"watch-list-all-namespaces-861"},{"section":"watch-list-860"},{"section":"watch-859"},{"section":"list-all-namespaces-858"},{"section":"list-857"},{"section":"read-856"}]},{"section":"-strong-write-operations-strong--849","subsections":[{"section":"delete-collection-854"},{"section":"delete-853"},{"section":"replace-852"},{"section":"patch-851"},{"section":"create-850"}]}]},{"section":"localsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--847","subsections":[{"section":"create-848"}]}]},{"section":"jobtemplatespec-v2alpha1-batch","subsections":[]},{"section":"initializer-v1alpha1-admissionregistration-k8s-io","subsections":[]},{"section":"ipblock-v1beta1-extensions","subsections":[]},{"section":"idrange-v1beta1-policy","subsections":[]},{"section":"hostportrange-v1beta1-policy","subsections":[]},{"section":"horizontalpodautoscaler-v2beta1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--843","subsections":[{"section":"replace-status-846"},{"section":"read-status-845"},{"section":"patch-status-844"}]},{"section":"-strong-read-operations-strong--836","subsections":[{"section":"watch-list-all-namespaces-842"},{"section":"watch-list-841"},{"section":"watch-840"},{"section":"list-all-namespaces-839"},{"section":"list-838"},{"section":"read-837"}]},{"section":"-strong-write-operations-strong--830","subsections":[{"section":"delete-collection-835"},{"section":"delete-834"},{"section":"replace-833"},{"section":"patch-832"},{"section":"create-831"}]}]},{"section":"fsgroupstrategyoptions-v1beta1-policy","subsections":[]},{"section":"eventseries-v1beta1-events-k8s-io","subsections":[]},{"section":"event-v1beta1-events-k8s-io","subsections":[{"section":"-strong-read-operations-strong--823","subsections":[{"section":"watch-list-all-namespaces-829"},{"section":"watch-list-828"},{"section":"watch-827"},{"section":"list-all-namespaces-826"},{"section":"list-825"},{"section":"read-824"}]},{"section":"-strong-write-operations-strong--817","subsections":[{"section":"delete-collection-822"},{"section":"delete-821"},{"section":"replace-820"},{"section":"patch-819"},{"section":"create-818"}]}]},{"section":"deploymentcondition-v1beta1-extensions","subsections":[]},{"section":"deploymentcondition-v1beta1-apps","subsections":[]},{"section":"deploymentcondition-v1beta2-apps","subsections":[]},{"section":"deployment-v1beta1-extensions","subsections":[{"section":"-strong-misc-operations-strong--812","subsections":[{"section":"rollback-816"},{"section":"patch-scale-815"},{"section":"replace-scale-814"},{"section":"read-scale-813"}]},{"section":"-strong-status-operations-strong--808","subsections":[{"section":"replace-status-811"},{"section":"read-status-810"},{"section":"patch-status-809"}]},{"section":"-strong-read-operations-strong--801","subsections":[{"section":"watch-list-all-namespaces-807"},{"section":"watch-list-806"},{"section":"watch-805"},{"section":"list-all-namespaces-804"},{"section":"list-803"},{"section":"read-802"}]},{"section":"-strong-write-operations-strong--795","subsections":[{"section":"delete-collection-800"},{"section":"delete-799"},{"section":"replace-798"},{"section":"patch-797"},{"section":"create-796"}]}]},{"section":"deployment-v1beta1-apps","subsections":[{"section":"-strong-misc-operations-strong--791","subsections":[{"section":"rollback"},{"section":"patch-scale-794"},{"section":"replace-scale-793"},{"section":"read-scale-792"}]},{"section":"-strong-status-operations-strong--787","subsections":[{"section":"replace-status-790"},{"section":"read-status-789"},{"section":"patch-status-788"}]},{"section":"-strong-read-operations-strong--780","subsections":[{"section":"watch-list-all-namespaces-786"},{"section":"watch-list-785"},{"section":"watch-784"},{"section":"list-all-namespaces-783"},{"section":"list-782"},{"section":"read-781"}]},{"section":"-strong-write-operations-strong--774","subsections":[{"section":"delete-collection-779"},{"section":"delete-778"},{"section":"replace-777"},{"section":"patch-776"},{"section":"create-775"}]}]},{"section":"deployment-v1beta2-apps","subsections":[{"section":"-strong-misc-operations-strong--770","subsections":[{"section":"patch-scale-773"},{"section":"replace-scale-772"},{"section":"read-scale-771"}]},{"section":"-strong-status-operations-strong--766","subsections":[{"section":"replace-status-769"},{"section":"read-status-768"},{"section":"patch-status-767"}]},{"section":"-strong-read-operations-strong--759","subsections":[{"section":"watch-list-all-namespaces-765"},{"section":"watch-list-764"},{"section":"watch-763"},{"section":"list-all-namespaces-762"},{"section":"list-761"},{"section":"read-760"}]},{"section":"-strong-write-operations-strong--753","subsections":[{"section":"delete-collection-758"},{"section":"delete-757"},{"section":"replace-756"},{"section":"patch-755"},{"section":"create-754"}]}]},{"section":"daemonsetupdatestrategy-v1beta1-extensions","subsections":[]},{"section":"daemonsetupdatestrategy-v1beta2-apps","subsections":[]},{"section":"daemonsetcondition-v1beta1-extensions","subsections":[]},{"section":"daemonsetcondition-v1beta2-apps","subsections":[]},{"section":"daemonset-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--749","subsections":[{"section":"replace-status-752"},{"section":"read-status-751"},{"section":"patch-status-750"}]},{"section":"-strong-read-operations-strong--742","subsections":[{"section":"watch-list-all-namespaces-748"},{"section":"watch-list-747"},{"section":"watch-746"},{"section":"list-all-namespaces-745"},{"section":"list-744"},{"section":"read-743"}]},{"section":"-strong-write-operations-strong--736","subsections":[{"section":"delete-collection-741"},{"section":"delete-740"},{"section":"replace-739"},{"section":"patch-738"},{"section":"create-737"}]}]},{"section":"daemonset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--732","subsections":[{"section":"replace-status-735"},{"section":"read-status-734"},{"section":"patch-status-733"}]},{"section":"-strong-read-operations-strong--725","subsections":[{"section":"watch-list-all-namespaces-731"},{"section":"watch-list-730"},{"section":"watch-729"},{"section":"list-all-namespaces-728"},{"section":"list-727"},{"section":"read-726"}]},{"section":"-strong-write-operations-strong--719","subsections":[{"section":"delete-collection-724"},{"section":"delete-723"},{"section":"replace-722"},{"section":"patch-721"},{"section":"create-720"}]}]},{"section":"crossversionobjectreference-v2beta1-autoscaling","subsections":[]},{"section":"cronjob-v2alpha1-batch","subsections":[{"section":"-strong-status-operations-strong--715","subsections":[{"section":"replace-status-718"},{"section":"read-status-717"},{"section":"patch-status-716"}]},{"section":"-strong-read-operations-strong--708","subsections":[{"section":"watch-list-all-namespaces-714"},{"section":"watch-list-713"},{"section":"watch-712"},{"section":"list-all-namespaces-711"},{"section":"list-710"},{"section":"read-709"}]},{"section":"-strong-write-operations-strong--702","subsections":[{"section":"delete-collection-707"},{"section":"delete-706"},{"section":"replace-705"},{"section":"patch-704"},{"section":"create-703"}]}]},{"section":"controllerrevision-v1beta1-apps","subsections":[{"section":"-strong-read-operations-strong--695","subsections":[{"section":"watch-list-all-namespaces-701"},{"section":"watch-list-700"},{"section":"watch-699"},{"section":"list-all-namespaces-698"},{"section":"list-697"},{"section":"read-696"}]},{"section":"-strong-write-operations-strong--689","subsections":[{"section":"delete-collection-694"},{"section":"delete-693"},{"section":"replace-692"},{"section":"patch-691"},{"section":"create-690"}]}]},{"section":"controllerrevision-v1beta2-apps","subsections":[{"section":"-strong-read-operations-strong--682","subsections":[{"section":"watch-list-all-namespaces-688"},{"section":"watch-list-687"},{"section":"watch-686"},{"section":"list-all-namespaces-685"},{"section":"list-684"},{"section":"read-683"}]},{"section":"-strong-write-operations-strong--676","subsections":[{"section":"delete-collection-681"},{"section":"delete-680"},{"section":"replace-679"},{"section":"patch-678"},{"section":"create-677"}]}]},{"section":"clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--671","subsections":[{"section":"watch-list-675"},{"section":"watch-674"},{"section":"list-673"},{"section":"read-672"}]},{"section":"-strong-write-operations-strong--665","subsections":[{"section":"delete-collection-670"},{"section":"delete-669"},{"section":"replace-668"},{"section":"patch-667"},{"section":"create-666"}]}]},{"section":"clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--660","subsections":[{"section":"watch-list-664"},{"section":"watch-663"},{"section":"list-662"},{"section":"read-661"}]},{"section":"-strong-write-operations-strong--654","subsections":[{"section":"delete-collection-659"},{"section":"delete-658"},{"section":"replace-657"},{"section":"patch-656"},{"section":"create-655"}]}]},{"section":"clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--649","subsections":[{"section":"watch-list-653"},{"section":"watch-652"},{"section":"list-651"},{"section":"read-650"}]},{"section":"-strong-write-operations-strong--643","subsections":[{"section":"delete-collection-648"},{"section":"delete-647"},{"section":"replace-646"},{"section":"patch-645"},{"section":"create-644"}]}]},{"section":"clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--638","subsections":[{"section":"watch-list-642"},{"section":"watch-641"},{"section":"list-640"},{"section":"read-639"}]},{"section":"-strong-write-operations-strong--632","subsections":[{"section":"delete-collection-637"},{"section":"delete-636"},{"section":"replace-635"},{"section":"patch-634"},{"section":"create-633"}]}]},{"section":"allowedhostpath-v1beta1-policy","subsections":[]},{"section":"allowedflexvolume-v1beta1-policy","subsections":[]},{"section":"aggregationrule-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"aggregationrule-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"apiservicecondition-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"apiservice-v1beta1-apiregistration-k8s-io","subsections":[{"section":"-strong-status-operations-strong--628","subsections":[{"section":"replace-status-631"},{"section":"read-status-630"},{"section":"patch-status-629"}]},{"section":"-strong-read-operations-strong--623","subsections":[{"section":"watch-list-627"},{"section":"watch-626"},{"section":"list-625"},{"section":"read-624"}]},{"section":"-strong-write-operations-strong--617","subsections":[{"section":"delete-collection-622"},{"section":"delete-621"},{"section":"replace-620"},{"section":"patch-619"},{"section":"create-618"}]}]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"-strong-definitions-strong-","subsections":[{"section":"weightedpodaffinityterm-v1-core"},{"section":"webhookclientconfig-v1beta1-admissionregistration"},{"section":"webhook-v1beta1-admissionregistration"},{"section":"watchevent-v1-meta"},{"section":"vspherevirtualdiskvolumesource-v1-core"},{"section":"volumeprojection-v1-core"},{"section":"volumenodeaffinity-v1-core"},{"section":"volumemount-v1-core"},{"section":"volumeerror-v1beta1-storage"},{"section":"volumedevice-v1-core"},{"section":"volumeattachmentsource-v1beta1-storage"},{"section":"userinfo-v1-authentication"},{"section":"topologyselectorterm-v1-core"},{"section":"topologyselectorlabelrequirement-v1-core"},{"section":"toleration-v1-core"},{"section":"time-v1-meta"},{"section":"taint-v1-core"},{"section":"tcpsocketaction-v1-core"},{"section":"sysctl-v1-core"},{"section":"supplementalgroupsstrategyoptions-v1beta1-extensions"},{"section":"subjectrulesreviewstatus-v1-authorization"},{"section":"subject-v1-rbac"},{"section":"storageosvolumesource-v1-core"},{"section":"storageospersistentvolumesource-v1-core"},{"section":"statusdetails-v1-meta"},{"section":"statuscause-v1-meta"},{"section":"status-v1-meta"},{"section":"statefulsetupdatestrategy-v1-apps"},{"section":"statefulsetcondition-v1-apps"},{"section":"sessionaffinityconfig-v1-core"},{"section":"servicereference-v1-apiregistration"},{"section":"serviceport-v1-core"},{"section":"serviceaccounttokenprojection-v1-core"},{"section":"serveraddressbyclientcidr-v1-meta"},{"section":"securitycontext-v1-core"},{"section":"secretvolumesource-v1-core"},{"section":"secretreference-v1-core"},{"section":"secretprojection-v1-core"},{"section":"secretkeyselector-v1-core"},{"section":"secretenvsource-v1-core"},{"section":"scopedresourceselectorrequirement-v1-core"},{"section":"scopeselector-v1-core"},{"section":"scaleiovolumesource-v1-core"},{"section":"scaleiopersistentvolumesource-v1-core"},{"section":"scale-v1-autoscaling"},{"section":"selinuxstrategyoptions-v1beta1-extensions"},{"section":"selinuxoptions-v1-core"},{"section":"runasuserstrategyoptions-v1beta1-extensions"},{"section":"rulewithoperations-v1beta1-admissionregistration"},{"section":"rule-v1alpha1-admissionregistration"},{"section":"rollingupdatestatefulsetstrategy-v1-apps"},{"section":"rollbackconfig-v1beta1-apps"},{"section":"roleref-v1-rbac"},{"section":"resourcerule-v1-authorization"},{"section":"resourcerequirements-v1-core"},{"section":"resourcemetricstatus-v2beta1-autoscaling"},{"section":"resourcemetricsource-v2beta1-autoscaling"},{"section":"resourcefieldselector-v1-core"},{"section":"resourceattributes-v1-authorization"},{"section":"replicationcontrollercondition-v1-core"},{"section":"replicasetcondition-v1-apps"},{"section":"rbdvolumesource-v1-core"},{"section":"rbdpersistentvolumesource-v1-core"},{"section":"quobytevolumesource-v1-core"},{"section":"quantity-resource-core"},{"section":"projectedvolumesource-v1-core"},{"section":"probe-v1-core"},{"section":"preferredschedulingterm-v1-core"},{"section":"preconditions-v1-meta"},{"section":"portworxvolumesource-v1-core"},{"section":"policyrule-v1-rbac"},{"section":"podsmetricstatus-v2beta1-autoscaling"},{"section":"podsmetricsource-v2beta1-autoscaling"},{"section":"podsecuritycontext-v1-core"},{"section":"podreadinessgate-v1-core"},{"section":"poddnsconfigoption-v1-core"},{"section":"poddnsconfig-v1-core"},{"section":"podcondition-v1-core"},{"section":"podantiaffinity-v1-core"},{"section":"podaffinityterm-v1-core"},{"section":"podaffinity-v1-core"},{"section":"photonpersistentdiskvolumesource-v1-core"},{"section":"persistentvolumeclaimvolumesource-v1-core"},{"section":"persistentvolumeclaimcondition-v1-core"},{"section":"patch-v1-meta"},{"section":"ownerreference-v1-meta"},{"section":"objectreference-v1-core"},{"section":"objectmetricstatus-v2beta1-autoscaling"},{"section":"objectmetricsource-v2beta1-autoscaling"},{"section":"objectmeta-v1-meta"},{"section":"objectfieldselector-v1-core"},{"section":"nonresourcerule-v1-authorization"},{"section":"nonresourceattributes-v1-authorization"},{"section":"nodesysteminfo-v1-core"},{"section":"nodeselectorterm-v1-core"},{"section":"nodeselectorrequirement-v1-core"},{"section":"nodeselector-v1-core"},{"section":"nodedaemonendpoints-v1-core"},{"section":"nodeconfigstatus-v1-core"},{"section":"nodeconfigsource-v1-core"},{"section":"nodecondition-v1-core"},{"section":"nodeaffinity-v1-core"},{"section":"nodeaddress-v1-core"},{"section":"networkpolicyport-v1-networking"},{"section":"networkpolicypeer-v1-networking"},{"section":"networkpolicyingressrule-v1-networking"},{"section":"networkpolicyegressrule-v1-networking"},{"section":"nfsvolumesource-v1-core"},{"section":"microtime-v1-meta"},{"section":"metricstatus-v2beta1-autoscaling"},{"section":"metricspec-v2beta1-autoscaling"},{"section":"localvolumesource-v1-core"},{"section":"localobjectreference-v1-core"},{"section":"loadbalancerstatus-v1-core"},{"section":"loadbalanceringress-v1-core"},{"section":"listmeta-v1-meta"},{"section":"limitrangeitem-v1-core"},{"section":"lifecycle-v1-core"},{"section":"labelselectorrequirement-v1-meta"},{"section":"labelselector-v1-meta"},{"section":"keytopath-v1-core"},{"section":"jobtemplatespec-v1beta1-batch"},{"section":"jobcondition-v1-batch"},{"section":"jsonschemapropsorbool-v1beta1-apiextensions"},{"section":"jsonschemapropsorarray-v1beta1-apiextensions"},{"section":"jsonschemaprops-v1beta1-apiextensions"},{"section":"json-v1beta1-apiextensions"},{"section":"initializers-v1-meta"},{"section":"initializer-v1-meta"},{"section":"ingresstls-v1beta1-extensions"},{"section":"ingressrule-v1beta1-extensions"},{"section":"ingressbackend-v1beta1-extensions"},{"section":"iscsivolumesource-v1-core"},{"section":"iscsipersistentvolumesource-v1-core"},{"section":"ipblock-v1-networking"},{"section":"idrange-v1beta1-extensions"},{"section":"hostportrange-v1beta1-extensions"},{"section":"hostpathvolumesource-v1-core"},{"section":"hostalias-v1-core"},{"section":"horizontalpodautoscalercondition-v2beta1-autoscaling"},{"section":"handler-v1-core"},{"section":"httpingressrulevalue-v1beta1-extensions"},{"section":"httpingresspath-v1beta1-extensions"},{"section":"httpheader-v1-core"},{"section":"httpgetaction-v1-core"},{"section":"groupversionfordiscovery-v1-meta"},{"section":"glusterfsvolumesource-v1-core"},{"section":"gitrepovolumesource-v1-core"},{"section":"gcepersistentdiskvolumesource-v1-core"},{"section":"flockervolumesource-v1-core"},{"section":"flexvolumesource-v1-core"},{"section":"flexpersistentvolumesource-v1-core"},{"section":"fsgroupstrategyoptions-v1beta1-extensions"},{"section":"fcvolumesource-v1-core"},{"section":"externalmetricstatus-v2beta1-autoscaling"},{"section":"externalmetricsource-v2beta1-autoscaling"},{"section":"externaldocumentation-v1beta1-apiextensions"},{"section":"execaction-v1-core"},{"section":"eviction-v1beta1-policy"},{"section":"eventsource-v1-core"},{"section":"eventseries-v1-core"},{"section":"envvarsource-v1-core"},{"section":"envvar-v1-core"},{"section":"envfromsource-v1-core"},{"section":"endpointsubset-v1-core"},{"section":"endpointport-v1-core"},{"section":"endpointaddress-v1-core"},{"section":"emptydirvolumesource-v1-core"},{"section":"downwardapivolumesource-v1-core"},{"section":"downwardapivolumefile-v1-core"},{"section":"downwardapiprojection-v1-core"},{"section":"deploymentcondition-v1-apps"},{"section":"deleteoptions-v1-meta"},{"section":"daemonsetupdatestrategy-v1-apps"},{"section":"daemonsetcondition-v1-apps"},{"section":"daemonendpoint-v1-core"},{"section":"customresourcevalidation-v1beta1-apiextensions"},{"section":"customresourcesubresources-v1beta1-apiextensions"},{"section":"customresourcesubresourcestatus-v1beta1-apiextensions"},{"section":"customresourcesubresourcescale-v1beta1-apiextensions"},{"section":"customresourcedefinitionversion-v1beta1-apiextensions"},{"section":"customresourcedefinitionnames-v1beta1-apiextensions"},{"section":"customresourcedefinitioncondition-v1beta1-apiextensions"},{"section":"customresourcecolumndefinition-v1beta1-apiextensions"},{"section":"crossversionobjectreference-v1-autoscaling"},{"section":"containerstatewaiting-v1-core"},{"section":"containerstateterminated-v1-core"},{"section":"containerstaterunning-v1-core"},{"section":"containerstate-v1-core"},{"section":"containerport-v1-core"},{"section":"containerimage-v1-core"},{"section":"configmapvolumesource-v1-core"},{"section":"configmapprojection-v1-core"},{"section":"configmapnodeconfigsource-v1-core"},{"section":"configmapkeyselector-v1-core"},{"section":"configmapenvsource-v1-core"},{"section":"componentcondition-v1-core"},{"section":"clientipconfig-v1-core"},{"section":"cindervolumesource-v1-core"},{"section":"cinderpersistentvolumesource-v1-core"},{"section":"certificatesigningrequestcondition-v1beta1-certificates"},{"section":"cephfsvolumesource-v1-core"},{"section":"cephfspersistentvolumesource-v1-core"},{"section":"capabilities-v1-core"},{"section":"csipersistentvolumesource-v1-core"},{"section":"azurefilevolumesource-v1-core"},{"section":"azurefilepersistentvolumesource-v1-core"},{"section":"azurediskvolumesource-v1-core"},{"section":"attachedvolume-v1-core"},{"section":"allowedhostpath-v1beta1-extensions"},{"section":"allowedflexvolume-v1beta1-extensions"},{"section":"aggregationrule-v1-rbac"},{"section":"affinity-v1-core"},{"section":"awselasticblockstorevolumesource-v1-core"},{"section":"apiversions-v1-meta"},{"section":"apiservicecondition-v1-apiregistration"},{"section":"apiresource-v1-meta"},{"section":"apigroup-v1-meta"}]},{"section":"networkpolicy-v1-networking-k8s-io","subsections":[{"section":"-strong-read-operations-strong--610","subsections":[{"section":"watch-list-all-namespaces-616"},{"section":"watch-list-615"},{"section":"watch-614"},{"section":"list-all-namespaces-613"},{"section":"list-612"},{"section":"read-611"}]},{"section":"-strong-write-operations-strong--604","subsections":[{"section":"delete-collection-609"},{"section":"delete-608"},{"section":"replace-607"},{"section":"patch-606"},{"section":"create-605"}]}]},{"section":"tokenreview-v1-authentication-k8s-io","subsections":[{"section":"-strong-write-operations-strong--602","subsections":[{"section":"create-603"}]}]},{"section":"subjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--600","subsections":[{"section":"create-601"}]}]},{"section":"serviceaccount-v1-core","subsections":[{"section":"-strong-read-operations-strong--593","subsections":[{"section":"watch-list-all-namespaces-599"},{"section":"watch-list-598"},{"section":"watch-597"},{"section":"list-all-namespaces-596"},{"section":"list-595"},{"section":"read-594"}]},{"section":"-strong-write-operations-strong--587","subsections":[{"section":"delete-collection-592"},{"section":"delete-591"},{"section":"replace-590"},{"section":"patch-589"},{"section":"create-588"}]}]},{"section":"selfsubjectrulesreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--585","subsections":[{"section":"create-586"}]}]},{"section":"selfsubjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--583","subsections":[{"section":"create-584"}]}]},{"section":"rolebinding-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--576","subsections":[{"section":"watch-list-all-namespaces-582"},{"section":"watch-list-581"},{"section":"watch-580"},{"section":"list-all-namespaces-579"},{"section":"list-578"},{"section":"read-577"}]},{"section":"-strong-write-operations-strong--570","subsections":[{"section":"delete-collection-575"},{"section":"delete-574"},{"section":"replace-573"},{"section":"patch-572"},{"section":"create-571"}]}]},{"section":"role-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--563","subsections":[{"section":"watch-list-all-namespaces-569"},{"section":"watch-list-568"},{"section":"watch-567"},{"section":"list-all-namespaces-566"},{"section":"list-565"},{"section":"read-564"}]},{"section":"-strong-write-operations-strong--557","subsections":[{"section":"delete-collection-562"},{"section":"delete-561"},{"section":"replace-560"},{"section":"patch-559"},{"section":"create-558"}]}]},{"section":"resourcequota-v1-core","subsections":[{"section":"-strong-status-operations-strong--553","subsections":[{"section":"replace-status-556"},{"section":"read-status-555"},{"section":"patch-status-554"}]},{"section":"-strong-read-operations-strong--546","subsections":[{"section":"watch-list-all-namespaces-552"},{"section":"watch-list-551"},{"section":"watch-550"},{"section":"list-all-namespaces-549"},{"section":"list-548"},{"section":"read-547"}]},{"section":"-strong-write-operations-strong--540","subsections":[{"section":"delete-collection-545"},{"section":"delete-544"},{"section":"replace-543"},{"section":"patch-542"},{"section":"create-541"}]}]},{"section":"persistentvolume-v1-core","subsections":[{"section":"-strong-status-operations-strong--536","subsections":[{"section":"replace-status-539"},{"section":"read-status-538"},{"section":"patch-status-537"}]},{"section":"-strong-read-operations-strong--531","subsections":[{"section":"watch-list-535"},{"section":"watch-534"},{"section":"list-533"},{"section":"read-532"}]},{"section":"-strong-write-operations-strong--525","subsections":[{"section":"delete-collection-530"},{"section":"delete-529"},{"section":"replace-528"},{"section":"patch-527"},{"section":"create-526"}]}]},{"section":"node-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--514","subsections":[{"section":"replace-connect-proxy-path-524"},{"section":"replace-connect-proxy-523"},{"section":"head-connect-proxy-path-522"},{"section":"head-connect-proxy-521"},{"section":"get-connect-proxy-path-520"},{"section":"get-connect-proxy-519"},{"section":"delete-connect-proxy-path-518"},{"section":"delete-connect-proxy-517"},{"section":"create-connect-proxy-path-516"},{"section":"create-connect-proxy-515"}]},{"section":"-strong-status-operations-strong--510","subsections":[{"section":"replace-status-513"},{"section":"read-status-512"},{"section":"patch-status-511"}]},{"section":"-strong-read-operations-strong--505","subsections":[{"section":"watch-list-509"},{"section":"watch-508"},{"section":"list-507"},{"section":"read-506"}]},{"section":"-strong-write-operations-strong--499","subsections":[{"section":"delete-collection-504"},{"section":"delete-503"},{"section":"replace-502"},{"section":"patch-501"},{"section":"create-500"}]}]},{"section":"namespace-v1-core","subsections":[{"section":"-strong-status-operations-strong--495","subsections":[{"section":"replace-status-498"},{"section":"read-status-497"},{"section":"patch-status-496"}]},{"section":"-strong-read-operations-strong--490","subsections":[{"section":"watch-list-494"},{"section":"watch-493"},{"section":"list-492"},{"section":"read-491"}]},{"section":"-strong-write-operations-strong--485","subsections":[{"section":"delete-489"},{"section":"replace-488"},{"section":"patch-487"},{"section":"create-486"}]}]},{"section":"localsubjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--483","subsections":[{"section":"create-484"}]}]},{"section":"componentstatus-v1-core","subsections":[{"section":"-strong-read-operations-strong--480","subsections":[{"section":"list-482"},{"section":"read-481"}]}]},{"section":"clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--475","subsections":[{"section":"watch-list-479"},{"section":"watch-478"},{"section":"list-477"},{"section":"read-476"}]},{"section":"-strong-write-operations-strong--469","subsections":[{"section":"delete-collection-474"},{"section":"delete-473"},{"section":"replace-472"},{"section":"patch-471"},{"section":"create-470"}]}]},{"section":"clusterrole-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--464","subsections":[{"section":"watch-list-468"},{"section":"watch-467"},{"section":"list-466"},{"section":"read-465"}]},{"section":"-strong-write-operations-strong--458","subsections":[{"section":"delete-collection-463"},{"section":"delete-462"},{"section":"replace-461"},{"section":"patch-460"},{"section":"create-459"}]}]},{"section":"certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[{"section":"-strong-status-operations-strong--454","subsections":[{"section":"replace-status-457"},{"section":"read-status-456"},{"section":"patch-status-455"}]},{"section":"-strong-read-operations-strong--449","subsections":[{"section":"watch-list-453"},{"section":"watch-452"},{"section":"list-451"},{"section":"read-450"}]},{"section":"-strong-write-operations-strong--443","subsections":[{"section":"delete-collection-448"},{"section":"delete-447"},{"section":"replace-446"},{"section":"patch-445"},{"section":"create-444"}]}]},{"section":"binding-v1-core","subsections":[{"section":"-strong-write-operations-strong--441","subsections":[{"section":"create-442"}]}]},{"section":"apiservice-v1-apiregistration-k8s-io","subsections":[{"section":"-strong-status-operations-strong--437","subsections":[{"section":"replace-status-440"},{"section":"read-status-439"},{"section":"patch-status-438"}]},{"section":"-strong-read-operations-strong--432","subsections":[{"section":"watch-list-436"},{"section":"watch-435"},{"section":"list-434"},{"section":"read-433"}]},{"section":"-strong-write-operations-strong--426","subsections":[{"section":"delete-collection-431"},{"section":"delete-430"},{"section":"replace-429"},{"section":"patch-428"},{"section":"create-427"}]}]},{"section":"-strong-cluster-strong-","subsections":[]},{"section":"podsecuritypolicy-v1beta1-extensions","subsections":[{"section":"-strong-read-operations-strong--421","subsections":[{"section":"watch-list-425"},{"section":"watch-424"},{"section":"list-423"},{"section":"read-422"}]},{"section":"-strong-write-operations-strong--415","subsections":[{"section":"delete-collection-420"},{"section":"delete-419"},{"section":"replace-418"},{"section":"patch-417"},{"section":"create-416"}]}]},{"section":"podpreset-v1alpha1-settings-k8s-io","subsections":[{"section":"-strong-read-operations-strong--408","subsections":[{"section":"watch-list-all-namespaces-414"},{"section":"watch-list-413"},{"section":"watch-412"},{"section":"list-all-namespaces-411"},{"section":"list-410"},{"section":"read-409"}]},{"section":"-strong-write-operations-strong--402","subsections":[{"section":"delete-collection-407"},{"section":"delete-406"},{"section":"replace-405"},{"section":"patch-404"},{"section":"create-403"}]}]},{"section":"priorityclass-v1beta1-scheduling-k8s-io","subsections":[{"section":"-strong-read-operations-strong--397","subsections":[{"section":"watch-list-401"},{"section":"watch-400"},{"section":"list-399"},{"section":"read-398"}]},{"section":"-strong-write-operations-strong--391","subsections":[{"section":"delete-collection-396"},{"section":"delete-395"},{"section":"replace-394"},{"section":"patch-393"},{"section":"create-392"}]}]},{"section":"poddisruptionbudget-v1beta1-policy","subsections":[{"section":"-strong-status-operations-strong--387","subsections":[{"section":"replace-status-390"},{"section":"read-status-389"},{"section":"patch-status-388"}]},{"section":"-strong-read-operations-strong--380","subsections":[{"section":"watch-list-all-namespaces-386"},{"section":"watch-list-385"},{"section":"watch-384"},{"section":"list-all-namespaces-383"},{"section":"list-382"},{"section":"read-381"}]},{"section":"-strong-write-operations-strong--374","subsections":[{"section":"delete-collection-379"},{"section":"delete-378"},{"section":"replace-377"},{"section":"patch-376"},{"section":"create-375"}]}]},{"section":"podtemplate-v1-core","subsections":[{"section":"-strong-read-operations-strong--367","subsections":[{"section":"watch-list-all-namespaces-373"},{"section":"watch-list-372"},{"section":"watch-371"},{"section":"list-all-namespaces-370"},{"section":"list-369"},{"section":"read-368"}]},{"section":"-strong-write-operations-strong--361","subsections":[{"section":"delete-collection-366"},{"section":"delete-365"},{"section":"replace-364"},{"section":"patch-363"},{"section":"create-362"}]}]},{"section":"validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-strong--356","subsections":[{"section":"watch-list-360"},{"section":"watch-359"},{"section":"list-358"},{"section":"read-357"}]},{"section":"-strong-write-operations-strong--350","subsections":[{"section":"delete-collection-355"},{"section":"delete-354"},{"section":"replace-353"},{"section":"patch-352"},{"section":"create-351"}]}]},{"section":"mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-strong--345","subsections":[{"section":"watch-list-349"},{"section":"watch-348"},{"section":"list-347"},{"section":"read-346"}]},{"section":"-strong-write-operations-strong--339","subsections":[{"section":"delete-collection-344"},{"section":"delete-343"},{"section":"replace-342"},{"section":"patch-341"},{"section":"create-340"}]}]},{"section":"initializerconfiguration-v1alpha1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-strong--334","subsections":[{"section":"watch-list-338"},{"section":"watch-337"},{"section":"list-336"},{"section":"read-335"}]},{"section":"-strong-write-operations-strong--328","subsections":[{"section":"delete-collection-333"},{"section":"delete-332"},{"section":"replace-331"},{"section":"patch-330"},{"section":"create-329"}]}]},{"section":"horizontalpodautoscaler-v1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--324","subsections":[{"section":"replace-status-327"},{"section":"read-status-326"},{"section":"patch-status-325"}]},{"section":"-strong-read-operations-strong--317","subsections":[{"section":"watch-list-all-namespaces-323"},{"section":"watch-list-322"},{"section":"watch-321"},{"section":"list-all-namespaces-320"},{"section":"list-319"},{"section":"read-318"}]},{"section":"-strong-write-operations-strong--311","subsections":[{"section":"delete-collection-316"},{"section":"delete-315"},{"section":"replace-314"},{"section":"patch-313"},{"section":"create-312"}]}]},{"section":"limitrange-v1-core","subsections":[{"section":"-strong-read-operations-strong--304","subsections":[{"section":"watch-list-all-namespaces-310"},{"section":"watch-list-309"},{"section":"watch-308"},{"section":"list-all-namespaces-307"},{"section":"list-306"},{"section":"read-305"}]},{"section":"-strong-write-operations-strong--298","subsections":[{"section":"delete-collection-303"},{"section":"delete-302"},{"section":"replace-301"},{"section":"patch-300"},{"section":"create-299"}]}]},{"section":"event-v1-core","subsections":[{"section":"-strong-read-operations-strong--291","subsections":[{"section":"watch-list-all-namespaces-297"},{"section":"watch-list-296"},{"section":"watch-295"},{"section":"list-all-namespaces-294"},{"section":"list-293"},{"section":"read-292"}]},{"section":"-strong-write-operations-strong--285","subsections":[{"section":"delete-collection-290"},{"section":"delete-289"},{"section":"replace-288"},{"section":"patch-287"},{"section":"create-286"}]}]},{"section":"customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[{"section":"-strong-status-operations-strong--281","subsections":[{"section":"replace-status-284"},{"section":"read-status-283"},{"section":"patch-status-282"}]},{"section":"-strong-read-operations-strong--276","subsections":[{"section":"watch-list-280"},{"section":"watch-279"},{"section":"list-278"},{"section":"read-277"}]},{"section":"-strong-write-operations-strong--270","subsections":[{"section":"delete-collection-275"},{"section":"delete-274"},{"section":"replace-273"},{"section":"patch-272"},{"section":"create-271"}]}]},{"section":"controllerrevision-v1-apps","subsections":[{"section":"-strong-read-operations-strong--263","subsections":[{"section":"watch-list-all-namespaces-269"},{"section":"watch-list-268"},{"section":"watch-267"},{"section":"list-all-namespaces-266"},{"section":"list-265"},{"section":"read-264"}]},{"section":"-strong-write-operations-strong--257","subsections":[{"section":"delete-collection-262"},{"section":"delete-261"},{"section":"replace-260"},{"section":"patch-259"},{"section":"create-258"}]}]},{"section":"-strong-metadata-strong-","subsections":[]},{"section":"volumeattachment-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--252","subsections":[{"section":"watch-list-256"},{"section":"watch-255"},{"section":"list-254"},{"section":"read-253"}]},{"section":"-strong-write-operations-strong--246","subsections":[{"section":"delete-collection-251"},{"section":"delete-250"},{"section":"replace-249"},{"section":"patch-248"},{"section":"create-247"}]}]},{"section":"volume-v1-core","subsections":[]},{"section":"storageclass-v1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--241","subsections":[{"section":"watch-list-245"},{"section":"watch-244"},{"section":"list-243"},{"section":"read-242"}]},{"section":"-strong-write-operations-strong--235","subsections":[{"section":"delete-collection-240"},{"section":"delete-239"},{"section":"replace-238"},{"section":"patch-237"},{"section":"create-236"}]}]},{"section":"persistentvolumeclaim-v1-core","subsections":[{"section":"-strong-status-operations-strong--231","subsections":[{"section":"replace-status-234"},{"section":"read-status-233"},{"section":"patch-status-232"}]},{"section":"-strong-read-operations-strong--224","subsections":[{"section":"watch-list-all-namespaces-230"},{"section":"watch-list-229"},{"section":"watch-228"},{"section":"list-all-namespaces-227"},{"section":"list-226"},{"section":"read-225"}]},{"section":"-strong-write-operations-strong--218","subsections":[{"section":"delete-collection-223"},{"section":"delete-222"},{"section":"replace-221"},{"section":"patch-220"},{"section":"create-219"}]}]},{"section":"secret-v1-core","subsections":[{"section":"-strong-read-operations-strong--211","subsections":[{"section":"watch-list-all-namespaces-217"},{"section":"watch-list-216"},{"section":"watch-215"},{"section":"list-all-namespaces-214"},{"section":"list-213"},{"section":"read-212"}]},{"section":"-strong-write-operations-strong--205","subsections":[{"section":"delete-collection-210"},{"section":"delete-209"},{"section":"replace-208"},{"section":"patch-207"},{"section":"create-206"}]}]},{"section":"configmap-v1-core","subsections":[{"section":"-strong-read-operations-strong--198","subsections":[{"section":"watch-list-all-namespaces-204"},{"section":"watch-list-203"},{"section":"watch-202"},{"section":"list-all-namespaces-201"},{"section":"list-200"},{"section":"read-199"}]},{"section":"-strong-write-operations-strong--192","subsections":[{"section":"delete-collection-197"},{"section":"delete-196"},{"section":"replace-195"},{"section":"patch-194"},{"section":"create-193"}]}]},{"section":"-strong-config-storage-strong-","subsections":[]},{"section":"service-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--181","subsections":[{"section":"replace-connect-proxy-path-191"},{"section":"replace-connect-proxy-190"},{"section":"head-connect-proxy-path-189"},{"section":"head-connect-proxy-188"},{"section":"get-connect-proxy-path-187"},{"section":"get-connect-proxy-186"},{"section":"delete-connect-proxy-path-185"},{"section":"delete-connect-proxy-184"},{"section":"create-connect-proxy-path-183"},{"section":"create-connect-proxy-182"}]},{"section":"-strong-status-operations-strong--177","subsections":[{"section":"replace-status-180"},{"section":"read-status-179"},{"section":"patch-status-178"}]},{"section":"-strong-read-operations-strong--170","subsections":[{"section":"watch-list-all-namespaces-176"},{"section":"watch-list-175"},{"section":"watch-174"},{"section":"list-all-namespaces-173"},{"section":"list-172"},{"section":"read-171"}]},{"section":"-strong-write-operations-strong--165","subsections":[{"section":"delete-169"},{"section":"replace-168"},{"section":"patch-167"},{"section":"create-166"}]}]},{"section":"ingress-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--161","subsections":[{"section":"replace-status-164"},{"section":"read-status-163"},{"section":"patch-status-162"}]},{"section":"-strong-read-operations-strong--154","subsections":[{"section":"watch-list-all-namespaces-160"},{"section":"watch-list-159"},{"section":"watch-158"},{"section":"list-all-namespaces-157"},{"section":"list-156"},{"section":"read-155"}]},{"section":"-strong-write-operations-strong--148","subsections":[{"section":"delete-collection-153"},{"section":"delete-152"},{"section":"replace-151"},{"section":"patch-150"},{"section":"create-149"}]}]},{"section":"endpoints-v1-core","subsections":[{"section":"-strong-read-operations-strong--141","subsections":[{"section":"watch-list-all-namespaces-147"},{"section":"watch-list-146"},{"section":"watch-145"},{"section":"list-all-namespaces-144"},{"section":"list-143"},{"section":"read-142"}]},{"section":"-strong-write-operations-strong--135","subsections":[{"section":"delete-collection-140"},{"section":"delete-139"},{"section":"replace-138"},{"section":"patch-137"},{"section":"create-136"}]}]},{"section":"-strong-discovery-load-balancing-strong-","subsections":[]},{"section":"statefulset-v1-apps","subsections":[{"section":"-strong-misc-operations-strong--131","subsections":[{"section":"patch-scale-134"},{"section":"replace-scale-133"},{"section":"read-scale-132"}]},{"section":"-strong-status-operations-strong--127","subsections":[{"section":"replace-status-130"},{"section":"read-status-129"},{"section":"patch-status-128"}]},{"section":"-strong-read-operations-strong--120","subsections":[{"section":"watch-list-all-namespaces-126"},{"section":"watch-list-125"},{"section":"watch-124"},{"section":"list-all-namespaces-123"},{"section":"list-122"},{"section":"read-121"}]},{"section":"-strong-write-operations-strong--114","subsections":[{"section":"delete-collection-119"},{"section":"delete-118"},{"section":"replace-117"},{"section":"patch-116"},{"section":"create-115"}]}]},{"section":"replicationcontroller-v1-core","subsections":[{"section":"-strong-misc-operations-strong--110","subsections":[{"section":"patch-scale-113"},{"section":"replace-scale-112"},{"section":"read-scale-111"}]},{"section":"-strong-status-operations-strong--106","subsections":[{"section":"replace-status-109"},{"section":"read-status-108"},{"section":"patch-status-107"}]},{"section":"-strong-read-operations-strong--99","subsections":[{"section":"watch-list-all-namespaces-105"},{"section":"watch-list-104"},{"section":"watch-103"},{"section":"list-all-namespaces-102"},{"section":"list-101"},{"section":"read-100"}]},{"section":"-strong-write-operations-strong--93","subsections":[{"section":"delete-collection-98"},{"section":"delete-97"},{"section":"replace-96"},{"section":"patch-95"},{"section":"create-94"}]}]},{"section":"replicaset-v1-apps","subsections":[{"section":"-strong-misc-operations-strong--89","subsections":[{"section":"patch-scale-92"},{"section":"replace-scale-91"},{"section":"read-scale-90"}]},{"section":"-strong-status-operations-strong--85","subsections":[{"section":"replace-status-88"},{"section":"read-status-87"},{"section":"patch-status-86"}]},{"section":"-strong-read-operations-strong--78","subsections":[{"section":"watch-list-all-namespaces-84"},{"section":"watch-list-83"},{"section":"watch-82"},{"section":"list-all-namespaces-81"},{"section":"list-80"},{"section":"read-79"}]},{"section":"-strong-write-operations-strong--72","subsections":[{"section":"delete-collection-77"},{"section":"delete-76"},{"section":"replace-75"},{"section":"patch-74"},{"section":"create-73"}]}]},{"section":"pod-v1-core","subsections":[{"section":"-strong-misc-operations-strong--71","subsections":[{"section":"read-log"}]},{"section":"-strong-proxy-operations-strong-","subsections":[{"section":"replace-connect-proxy-path"},{"section":"replace-connect-proxy"},{"section":"head-connect-proxy-path"},{"section":"head-connect-proxy"},{"section":"get-connect-proxy-path"},{"section":"get-connect-proxy"},{"section":"get-connect-portforward"},{"section":"delete-connect-proxy-path"},{"section":"delete-connect-proxy"},{"section":"create-connect-proxy-path"},{"section":"create-connect-proxy"},{"section":"create-connect-portforward"}]},{"section":"-strong-status-operations-strong--67","subsections":[{"section":"replace-status-70"},{"section":"read-status-69"},{"section":"patch-status-68"}]},{"section":"-strong-read-operations-strong--60","subsections":[{"section":"watch-list-all-namespaces-66"},{"section":"watch-list-65"},{"section":"watch-64"},{"section":"list-all-namespaces-63"},{"section":"list-62"},{"section":"read-61"}]},{"section":"-strong-write-operations-strong--54","subsections":[{"section":"delete-collection-59"},{"section":"delete-58"},{"section":"replace-57"},{"section":"patch-56"},{"section":"create-eviction"},{"section":"create-55"}]}]},{"section":"job-v1-batch","subsections":[{"section":"-strong-status-operations-strong--50","subsections":[{"section":"replace-status-53"},{"section":"read-status-52"},{"section":"patch-status-51"}]},{"section":"-strong-read-operations-strong--43","subsections":[{"section":"watch-list-all-namespaces-49"},{"section":"watch-list-48"},{"section":"watch-47"},{"section":"list-all-namespaces-46"},{"section":"list-45"},{"section":"read-44"}]},{"section":"-strong-write-operations-strong--37","subsections":[{"section":"delete-collection-42"},{"section":"delete-41"},{"section":"replace-40"},{"section":"patch-39"},{"section":"create-38"}]}]},{"section":"deployment-v1-apps","subsections":[{"section":"-strong-misc-operations-strong-","subsections":[{"section":"patch-scale"},{"section":"replace-scale"},{"section":"read-scale"}]},{"section":"-strong-status-operations-strong--33","subsections":[{"section":"replace-status-36"},{"section":"read-status-35"},{"section":"patch-status-34"}]},{"section":"-strong-read-operations-strong--26","subsections":[{"section":"watch-list-all-namespaces-32"},{"section":"watch-list-31"},{"section":"watch-30"},{"section":"list-all-namespaces-29"},{"section":"list-28"},{"section":"read-27"}]},{"section":"-strong-write-operations-strong--20","subsections":[{"section":"delete-collection-25"},{"section":"delete-24"},{"section":"replace-23"},{"section":"patch-22"},{"section":"create-21"}]}]},{"section":"daemonset-v1-apps","subsections":[{"section":"-strong-status-operations-strong--16","subsections":[{"section":"replace-status-19"},{"section":"read-status-18"},{"section":"patch-status-17"}]},{"section":"-strong-read-operations-strong--9","subsections":[{"section":"watch-list-all-namespaces-15"},{"section":"watch-list-14"},{"section":"watch-13"},{"section":"list-all-namespaces-12"},{"section":"list-11"},{"section":"read-10"}]},{"section":"-strong-write-operations-strong--3","subsections":[{"section":"delete-collection-8"},{"section":"delete-7"},{"section":"replace-6"},{"section":"patch-5"},{"section":"create-4"}]}]},{"section":"cronjob-v1beta1-batch","subsections":[{"section":"-strong-status-operations-strong-","subsections":[{"section":"replace-status"},{"section":"read-status"},{"section":"patch-status"}]},{"section":"-strong-read-operations-strong-","subsections":[{"section":"watch-list-all-namespaces"},{"section":"watch-list"},{"section":"watch"},{"section":"list-all-namespaces"},{"section":"list"},{"section":"read-2"}]},{"section":"-strong-write-operations-strong-","subsections":[{"section":"delete-collection"},{"section":"delete-1"},{"section":"replace"},{"section":"patch"},{"section":"create"}]}]},{"section":"container-v1-core","subsections":[]},{"section":"-strong-workloads-strong-","subsections":[]},{"section":"-strong-api-overview-strong-","subsections":[{"section":"resource-operations"},{"section":"resource-objects"},{"section":"resource-categories"}]}],"flatToc":["volumeerror-v1alpha1-storage-k8s-io","volumeattachmentsource-v1alpha1-storage-k8s-io","watch-list-1049","watch-1048","list-1047","read-1046","-strong-read-operations-strong--1045","delete-collection-1044","delete-1043","replace-1042","patch-1041","create-1040","-strong-write-operations-strong--1039","volumeattachment-v1alpha1-storage-k8s-io","userinfo-v1beta1-authentication-k8s-io","create-1038","-strong-write-operations-strong--1037","tokenreview-v1beta1-authentication-k8s-io","supplementalgroupsstrategyoptions-v1beta1-policy","subjectrulesreviewstatus-v1beta1-authorization-k8s-io","create-1036","-strong-write-operations-strong--1035","subjectaccessreview-v1beta1-authorization-k8s-io","subject-v1alpha1-rbac-authorization-k8s-io","subject-v1beta1-rbac-authorization-k8s-io","watch-list-1034","watch-1033","list-1032","read-1031","-strong-read-operations-strong--1030","delete-collection-1029","delete-1028","replace-1027","patch-1026","create-1025","-strong-write-operations-strong--1024","storageclass-v1beta1-storage-k8s-io","statefulsetupdatestrategy-v1beta1-apps","statefulsetupdatestrategy-v1beta2-apps","statefulsetcondition-v1beta1-apps","statefulsetcondition-v1beta2-apps","patch-scale-1023","replace-scale-1022","read-scale-1021","-strong-misc-operations-strong--1020","replace-status-1019","read-status-1018","patch-status-1017","-strong-status-operations-strong--1016","watch-list-all-namespaces-1015","watch-list-1014","watch-1013","list-all-namespaces-1012","list-1011","read-1010","-strong-read-operations-strong--1009","delete-collection-1008","delete-1007","replace-1006","patch-1005","create-1004","-strong-write-operations-strong--1003","statefulset-v1beta1-apps","patch-scale-1002","replace-scale-1001","read-scale-1000","-strong-misc-operations-strong--999","replace-status-998","read-status-997","patch-status-996","-strong-status-operations-strong--995","watch-list-all-namespaces-994","watch-list-993","watch-992","list-all-namespaces-991","list-990","read-989","-strong-read-operations-strong--988","delete-collection-987","delete-986","replace-985","patch-984","create-983","-strong-write-operations-strong--982","statefulset-v1beta2-apps","servicereference-v1beta1-apiregistration-k8s-io","servicereference-v1beta1-admissionregistration-k8s-io","create-981","-strong-write-operations-strong--980","selfsubjectrulesreview-v1beta1-authorization-k8s-io","create-979","-strong-write-operations-strong--978","selfsubjectaccessreview-v1beta1-authorization-k8s-io","scale-v1beta1-extensions","scale-v1beta1-apps","scale-v1beta2-apps","selinuxstrategyoptions-v1beta1-policy","runasuserstrategyoptions-v1beta1-policy","rollingupdatestatefulsetstrategy-v1beta1-apps","rollingupdatestatefulsetstrategy-v1beta2-apps","rollbackconfig-v1beta1-extensions","roleref-v1alpha1-rbac-authorization-k8s-io","roleref-v1beta1-rbac-authorization-k8s-io","watch-list-all-namespaces-977","watch-list-976","watch-975","list-all-namespaces-974","list-973","read-972","-strong-read-operations-strong--971","delete-collection-970","delete-969","replace-968","patch-967","create-966","-strong-write-operations-strong--965","rolebinding-v1alpha1-rbac-authorization-k8s-io","watch-list-all-namespaces-964","watch-list-963","watch-962","list-all-namespaces-961","list-960","read-959","-strong-read-operations-strong--958","delete-collection-957","delete-956","replace-955","patch-954","create-953","-strong-write-operations-strong--952","rolebinding-v1beta1-rbac-authorization-k8s-io","watch-list-all-namespaces-951","watch-list-950","watch-949","list-all-namespaces-948","list-947","read-946","-strong-read-operations-strong--945","delete-collection-944","delete-943","replace-942","patch-941","create-940","-strong-write-operations-strong--939","role-v1alpha1-rbac-authorization-k8s-io","watch-list-all-namespaces-938","watch-list-937","watch-936","list-all-namespaces-935","list-934","read-933","-strong-read-operations-strong--932","delete-collection-931","delete-930","replace-929","patch-928","create-927","-strong-write-operations-strong--926","role-v1beta1-rbac-authorization-k8s-io","resourcerule-v1beta1-authorization-k8s-io","resourceattributes-v1beta1-authorization-k8s-io","replicasetcondition-v1beta1-extensions","replicasetcondition-v1beta2-apps","patch-scale-925","replace-scale-924","read-scale-923","-strong-misc-operations-strong--922","replace-status-921","read-status-920","patch-status-919","-strong-status-operations-strong--918","watch-list-all-namespaces-917","watch-list-916","watch-915","list-all-namespaces-914","list-913","read-912","-strong-read-operations-strong--911","delete-collection-910","delete-909","replace-908","patch-907","create-906","-strong-write-operations-strong--905","replicaset-v1beta1-extensions","patch-scale-904","replace-scale-903","read-scale-902","-strong-misc-operations-strong--901","replace-status-900","read-status-899","patch-status-898","-strong-status-operations-strong--897","watch-list-all-namespaces-896","watch-list-895","watch-894","list-all-namespaces-893","list-892","read-891","-strong-read-operations-strong--890","delete-collection-889","delete-888","replace-887","patch-886","create-885","-strong-write-operations-strong--884","replicaset-v1beta2-apps","watch-list-883","watch-882","list-881","read-880","-strong-read-operations-strong--879","delete-collection-878","delete-877","replace-876","patch-875","create-874","-strong-write-operations-strong--873","priorityclass-v1alpha1-scheduling-k8s-io","policyrule-v1alpha1-rbac-authorization-k8s-io","policyrule-v1beta1-rbac-authorization-k8s-io","watch-list-872","watch-871","list-870","read-869","-strong-read-operations-strong--868","delete-collection-867","delete-866","replace-865","patch-864","create-863","-strong-write-operations-strong--862","podsecuritypolicy-v1beta1-policy","nonresourcerule-v1beta1-authorization-k8s-io","nonresourceattributes-v1beta1-authorization-k8s-io","networkpolicyport-v1beta1-extensions","networkpolicypeer-v1beta1-extensions","networkpolicyingressrule-v1beta1-extensions","networkpolicyegressrule-v1beta1-extensions","watch-list-all-namespaces-861","watch-list-860","watch-859","list-all-namespaces-858","list-857","read-856","-strong-read-operations-strong--855","delete-collection-854","delete-853","replace-852","patch-851","create-850","-strong-write-operations-strong--849","networkpolicy-v1beta1-extensions","create-848","-strong-write-operations-strong--847","localsubjectaccessreview-v1beta1-authorization-k8s-io","jobtemplatespec-v2alpha1-batch","initializer-v1alpha1-admissionregistration-k8s-io","ipblock-v1beta1-extensions","idrange-v1beta1-policy","hostportrange-v1beta1-policy","replace-status-846","read-status-845","patch-status-844","-strong-status-operations-strong--843","watch-list-all-namespaces-842","watch-list-841","watch-840","list-all-namespaces-839","list-838","read-837","-strong-read-operations-strong--836","delete-collection-835","delete-834","replace-833","patch-832","create-831","-strong-write-operations-strong--830","horizontalpodautoscaler-v2beta1-autoscaling","fsgroupstrategyoptions-v1beta1-policy","eventseries-v1beta1-events-k8s-io","watch-list-all-namespaces-829","watch-list-828","watch-827","list-all-namespaces-826","list-825","read-824","-strong-read-operations-strong--823","delete-collection-822","delete-821","replace-820","patch-819","create-818","-strong-write-operations-strong--817","event-v1beta1-events-k8s-io","deploymentcondition-v1beta1-extensions","deploymentcondition-v1beta1-apps","deploymentcondition-v1beta2-apps","rollback-816","patch-scale-815","replace-scale-814","read-scale-813","-strong-misc-operations-strong--812","replace-status-811","read-status-810","patch-status-809","-strong-status-operations-strong--808","watch-list-all-namespaces-807","watch-list-806","watch-805","list-all-namespaces-804","list-803","read-802","-strong-read-operations-strong--801","delete-collection-800","delete-799","replace-798","patch-797","create-796","-strong-write-operations-strong--795","deployment-v1beta1-extensions","rollback","patch-scale-794","replace-scale-793","read-scale-792","-strong-misc-operations-strong--791","replace-status-790","read-status-789","patch-status-788","-strong-status-operations-strong--787","watch-list-all-namespaces-786","watch-list-785","watch-784","list-all-namespaces-783","list-782","read-781","-strong-read-operations-strong--780","delete-collection-779","delete-778","replace-777","patch-776","create-775","-strong-write-operations-strong--774","deployment-v1beta1-apps","patch-scale-773","replace-scale-772","read-scale-771","-strong-misc-operations-strong--770","replace-status-769","read-status-768","patch-status-767","-strong-status-operations-strong--766","watch-list-all-namespaces-765","watch-list-764","watch-763","list-all-namespaces-762","list-761","read-760","-strong-read-operations-strong--759","delete-collection-758","delete-757","replace-756","patch-755","create-754","-strong-write-operations-strong--753","deployment-v1beta2-apps","daemonsetupdatestrategy-v1beta1-extensions","daemonsetupdatestrategy-v1beta2-apps","daemonsetcondition-v1beta1-extensions","daemonsetcondition-v1beta2-apps","replace-status-752","read-status-751","patch-status-750","-strong-status-operations-strong--749","watch-list-all-namespaces-748","watch-list-747","watch-746","list-all-namespaces-745","list-744","read-743","-strong-read-operations-strong--742","delete-collection-741","delete-740","replace-739","patch-738","create-737","-strong-write-operations-strong--736","daemonset-v1beta1-extensions","replace-status-735","read-status-734","patch-status-733","-strong-status-operations-strong--732","watch-list-all-namespaces-731","watch-list-730","watch-729","list-all-namespaces-728","list-727","read-726","-strong-read-operations-strong--725","delete-collection-724","delete-723","replace-722","patch-721","create-720","-strong-write-operations-strong--719","daemonset-v1beta2-apps","crossversionobjectreference-v2beta1-autoscaling","replace-status-718","read-status-717","patch-status-716","-strong-status-operations-strong--715","watch-list-all-namespaces-714","watch-list-713","watch-712","list-all-namespaces-711","list-710","read-709","-strong-read-operations-strong--708","delete-collection-707","delete-706","replace-705","patch-704","create-703","-strong-write-operations-strong--702","cronjob-v2alpha1-batch","watch-list-all-namespaces-701","watch-list-700","watch-699","list-all-namespaces-698","list-697","read-696","-strong-read-operations-strong--695","delete-collection-694","delete-693","replace-692","patch-691","create-690","-strong-write-operations-strong--689","controllerrevision-v1beta1-apps","watch-list-all-namespaces-688","watch-list-687","watch-686","list-all-namespaces-685","list-684","read-683","-strong-read-operations-strong--682","delete-collection-681","delete-680","replace-679","patch-678","create-677","-strong-write-operations-strong--676","controllerrevision-v1beta2-apps","watch-list-675","watch-674","list-673","read-672","-strong-read-operations-strong--671","delete-collection-670","delete-669","replace-668","patch-667","create-666","-strong-write-operations-strong--665","clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","watch-list-664","watch-663","list-662","read-661","-strong-read-operations-strong--660","delete-collection-659","delete-658","replace-657","patch-656","create-655","-strong-write-operations-strong--654","clusterrolebinding-v1beta1-rbac-authorization-k8s-io","watch-list-653","watch-652","list-651","read-650","-strong-read-operations-strong--649","delete-collection-648","delete-647","replace-646","patch-645","create-644","-strong-write-operations-strong--643","clusterrole-v1alpha1-rbac-authorization-k8s-io","watch-list-642","watch-641","list-640","read-639","-strong-read-operations-strong--638","delete-collection-637","delete-636","replace-635","patch-634","create-633","-strong-write-operations-strong--632","clusterrole-v1beta1-rbac-authorization-k8s-io","allowedhostpath-v1beta1-policy","allowedflexvolume-v1beta1-policy","aggregationrule-v1alpha1-rbac-authorization-k8s-io","aggregationrule-v1beta1-rbac-authorization-k8s-io","apiservicecondition-v1beta1-apiregistration-k8s-io","replace-status-631","read-status-630","patch-status-629","-strong-status-operations-strong--628","watch-list-627","watch-626","list-625","read-624","-strong-read-operations-strong--623","delete-collection-622","delete-621","replace-620","patch-619","create-618","-strong-write-operations-strong--617","apiservice-v1beta1-apiregistration-k8s-io","-strong-old-api-versions-strong-","weightedpodaffinityterm-v1-core","webhookclientconfig-v1beta1-admissionregistration","webhook-v1beta1-admissionregistration","watchevent-v1-meta","vspherevirtualdiskvolumesource-v1-core","volumeprojection-v1-core","volumenodeaffinity-v1-core","volumemount-v1-core","volumeerror-v1beta1-storage","volumedevice-v1-core","volumeattachmentsource-v1beta1-storage","userinfo-v1-authentication","topologyselectorterm-v1-core","topologyselectorlabelrequirement-v1-core","toleration-v1-core","time-v1-meta","taint-v1-core","tcpsocketaction-v1-core","sysctl-v1-core","supplementalgroupsstrategyoptions-v1beta1-extensions","subjectrulesreviewstatus-v1-authorization","subject-v1-rbac","storageosvolumesource-v1-core","storageospersistentvolumesource-v1-core","statusdetails-v1-meta","statuscause-v1-meta","status-v1-meta","statefulsetupdatestrategy-v1-apps","statefulsetcondition-v1-apps","sessionaffinityconfig-v1-core","servicereference-v1-apiregistration","serviceport-v1-core","serviceaccounttokenprojection-v1-core","serveraddressbyclientcidr-v1-meta","securitycontext-v1-core","secretvolumesource-v1-core","secretreference-v1-core","secretprojection-v1-core","secretkeyselector-v1-core","secretenvsource-v1-core","scopedresourceselectorrequirement-v1-core","scopeselector-v1-core","scaleiovolumesource-v1-core","scaleiopersistentvolumesource-v1-core","scale-v1-autoscaling","selinuxstrategyoptions-v1beta1-extensions","selinuxoptions-v1-core","runasuserstrategyoptions-v1beta1-extensions","rulewithoperations-v1beta1-admissionregistration","rule-v1alpha1-admissionregistration","rollingupdatestatefulsetstrategy-v1-apps","rollbackconfig-v1beta1-apps","roleref-v1-rbac","resourcerule-v1-authorization","resourcerequirements-v1-core","resourcemetricstatus-v2beta1-autoscaling","resourcemetricsource-v2beta1-autoscaling","resourcefieldselector-v1-core","resourceattributes-v1-authorization","replicationcontrollercondition-v1-core","replicasetcondition-v1-apps","rbdvolumesource-v1-core","rbdpersistentvolumesource-v1-core","quobytevolumesource-v1-core","quantity-resource-core","projectedvolumesource-v1-core","probe-v1-core","preferredschedulingterm-v1-core","preconditions-v1-meta","portworxvolumesource-v1-core","policyrule-v1-rbac","podsmetricstatus-v2beta1-autoscaling","podsmetricsource-v2beta1-autoscaling","podsecuritycontext-v1-core","podreadinessgate-v1-core","poddnsconfigoption-v1-core","poddnsconfig-v1-core","podcondition-v1-core","podantiaffinity-v1-core","podaffinityterm-v1-core","podaffinity-v1-core","photonpersistentdiskvolumesource-v1-core","persistentvolumeclaimvolumesource-v1-core","persistentvolumeclaimcondition-v1-core","patch-v1-meta","ownerreference-v1-meta","objectreference-v1-core","objectmetricstatus-v2beta1-autoscaling","objectmetricsource-v2beta1-autoscaling","objectmeta-v1-meta","objectfieldselector-v1-core","nonresourcerule-v1-authorization","nonresourceattributes-v1-authorization","nodesysteminfo-v1-core","nodeselectorterm-v1-core","nodeselectorrequirement-v1-core","nodeselector-v1-core","nodedaemonendpoints-v1-core","nodeconfigstatus-v1-core","nodeconfigsource-v1-core","nodecondition-v1-core","nodeaffinity-v1-core","nodeaddress-v1-core","networkpolicyport-v1-networking","networkpolicypeer-v1-networking","networkpolicyingressrule-v1-networking","networkpolicyegressrule-v1-networking","nfsvolumesource-v1-core","microtime-v1-meta","metricstatus-v2beta1-autoscaling","metricspec-v2beta1-autoscaling","localvolumesource-v1-core","localobjectreference-v1-core","loadbalancerstatus-v1-core","loadbalanceringress-v1-core","listmeta-v1-meta","limitrangeitem-v1-core","lifecycle-v1-core","labelselectorrequirement-v1-meta","labelselector-v1-meta","keytopath-v1-core","jobtemplatespec-v1beta1-batch","jobcondition-v1-batch","jsonschemapropsorbool-v1beta1-apiextensions","jsonschemapropsorarray-v1beta1-apiextensions","jsonschemaprops-v1beta1-apiextensions","json-v1beta1-apiextensions","initializers-v1-meta","initializer-v1-meta","ingresstls-v1beta1-extensions","ingressrule-v1beta1-extensions","ingressbackend-v1beta1-extensions","iscsivolumesource-v1-core","iscsipersistentvolumesource-v1-core","ipblock-v1-networking","idrange-v1beta1-extensions","hostportrange-v1beta1-extensions","hostpathvolumesource-v1-core","hostalias-v1-core","horizontalpodautoscalercondition-v2beta1-autoscaling","handler-v1-core","httpingressrulevalue-v1beta1-extensions","httpingresspath-v1beta1-extensions","httpheader-v1-core","httpgetaction-v1-core","groupversionfordiscovery-v1-meta","glusterfsvolumesource-v1-core","gitrepovolumesource-v1-core","gcepersistentdiskvolumesource-v1-core","flockervolumesource-v1-core","flexvolumesource-v1-core","flexpersistentvolumesource-v1-core","fsgroupstrategyoptions-v1beta1-extensions","fcvolumesource-v1-core","externalmetricstatus-v2beta1-autoscaling","externalmetricsource-v2beta1-autoscaling","externaldocumentation-v1beta1-apiextensions","execaction-v1-core","eviction-v1beta1-policy","eventsource-v1-core","eventseries-v1-core","envvarsource-v1-core","envvar-v1-core","envfromsource-v1-core","endpointsubset-v1-core","endpointport-v1-core","endpointaddress-v1-core","emptydirvolumesource-v1-core","downwardapivolumesource-v1-core","downwardapivolumefile-v1-core","downwardapiprojection-v1-core","deploymentcondition-v1-apps","deleteoptions-v1-meta","daemonsetupdatestrategy-v1-apps","daemonsetcondition-v1-apps","daemonendpoint-v1-core","customresourcevalidation-v1beta1-apiextensions","customresourcesubresources-v1beta1-apiextensions","customresourcesubresourcestatus-v1beta1-apiextensions","customresourcesubresourcescale-v1beta1-apiextensions","customresourcedefinitionversion-v1beta1-apiextensions","customresourcedefinitionnames-v1beta1-apiextensions","customresourcedefinitioncondition-v1beta1-apiextensions","customresourcecolumndefinition-v1beta1-apiextensions","crossversionobjectreference-v1-autoscaling","containerstatewaiting-v1-core","containerstateterminated-v1-core","containerstaterunning-v1-core","containerstate-v1-core","containerport-v1-core","containerimage-v1-core","configmapvolumesource-v1-core","configmapprojection-v1-core","configmapnodeconfigsource-v1-core","configmapkeyselector-v1-core","configmapenvsource-v1-core","componentcondition-v1-core","clientipconfig-v1-core","cindervolumesource-v1-core","cinderpersistentvolumesource-v1-core","certificatesigningrequestcondition-v1beta1-certificates","cephfsvolumesource-v1-core","cephfspersistentvolumesource-v1-core","capabilities-v1-core","csipersistentvolumesource-v1-core","azurefilevolumesource-v1-core","azurefilepersistentvolumesource-v1-core","azurediskvolumesource-v1-core","attachedvolume-v1-core","allowedhostpath-v1beta1-extensions","allowedflexvolume-v1beta1-extensions","aggregationrule-v1-rbac","affinity-v1-core","awselasticblockstorevolumesource-v1-core","apiversions-v1-meta","apiservicecondition-v1-apiregistration","apiresource-v1-meta","apigroup-v1-meta","-strong-definitions-strong-","watch-list-all-namespaces-616","watch-list-615","watch-614","list-all-namespaces-613","list-612","read-611","-strong-read-operations-strong--610","delete-collection-609","delete-608","replace-607","patch-606","create-605","-strong-write-operations-strong--604","networkpolicy-v1-networking-k8s-io","create-603","-strong-write-operations-strong--602","tokenreview-v1-authentication-k8s-io","create-601","-strong-write-operations-strong--600","subjectaccessreview-v1-authorization-k8s-io","watch-list-all-namespaces-599","watch-list-598","watch-597","list-all-namespaces-596","list-595","read-594","-strong-read-operations-strong--593","delete-collection-592","delete-591","replace-590","patch-589","create-588","-strong-write-operations-strong--587","serviceaccount-v1-core","create-586","-strong-write-operations-strong--585","selfsubjectrulesreview-v1-authorization-k8s-io","create-584","-strong-write-operations-strong--583","selfsubjectaccessreview-v1-authorization-k8s-io","watch-list-all-namespaces-582","watch-list-581","watch-580","list-all-namespaces-579","list-578","read-577","-strong-read-operations-strong--576","delete-collection-575","delete-574","replace-573","patch-572","create-571","-strong-write-operations-strong--570","rolebinding-v1-rbac-authorization-k8s-io","watch-list-all-namespaces-569","watch-list-568","watch-567","list-all-namespaces-566","list-565","read-564","-strong-read-operations-strong--563","delete-collection-562","delete-561","replace-560","patch-559","create-558","-strong-write-operations-strong--557","role-v1-rbac-authorization-k8s-io","replace-status-556","read-status-555","patch-status-554","-strong-status-operations-strong--553","watch-list-all-namespaces-552","watch-list-551","watch-550","list-all-namespaces-549","list-548","read-547","-strong-read-operations-strong--546","delete-collection-545","delete-544","replace-543","patch-542","create-541","-strong-write-operations-strong--540","resourcequota-v1-core","replace-status-539","read-status-538","patch-status-537","-strong-status-operations-strong--536","watch-list-535","watch-534","list-533","read-532","-strong-read-operations-strong--531","delete-collection-530","delete-529","replace-528","patch-527","create-526","-strong-write-operations-strong--525","persistentvolume-v1-core","replace-connect-proxy-path-524","replace-connect-proxy-523","head-connect-proxy-path-522","head-connect-proxy-521","get-connect-proxy-path-520","get-connect-proxy-519","delete-connect-proxy-path-518","delete-connect-proxy-517","create-connect-proxy-path-516","create-connect-proxy-515","-strong-proxy-operations-strong--514","replace-status-513","read-status-512","patch-status-511","-strong-status-operations-strong--510","watch-list-509","watch-508","list-507","read-506","-strong-read-operations-strong--505","delete-collection-504","delete-503","replace-502","patch-501","create-500","-strong-write-operations-strong--499","node-v1-core","replace-status-498","read-status-497","patch-status-496","-strong-status-operations-strong--495","watch-list-494","watch-493","list-492","read-491","-strong-read-operations-strong--490","delete-489","replace-488","patch-487","create-486","-strong-write-operations-strong--485","namespace-v1-core","create-484","-strong-write-operations-strong--483","localsubjectaccessreview-v1-authorization-k8s-io","list-482","read-481","-strong-read-operations-strong--480","componentstatus-v1-core","watch-list-479","watch-478","list-477","read-476","-strong-read-operations-strong--475","delete-collection-474","delete-473","replace-472","patch-471","create-470","-strong-write-operations-strong--469","clusterrolebinding-v1-rbac-authorization-k8s-io","watch-list-468","watch-467","list-466","read-465","-strong-read-operations-strong--464","delete-collection-463","delete-462","replace-461","patch-460","create-459","-strong-write-operations-strong--458","clusterrole-v1-rbac-authorization-k8s-io","replace-status-457","read-status-456","patch-status-455","-strong-status-operations-strong--454","watch-list-453","watch-452","list-451","read-450","-strong-read-operations-strong--449","delete-collection-448","delete-447","replace-446","patch-445","create-444","-strong-write-operations-strong--443","certificatesigningrequest-v1beta1-certificates-k8s-io","create-442","-strong-write-operations-strong--441","binding-v1-core","replace-status-440","read-status-439","patch-status-438","-strong-status-operations-strong--437","watch-list-436","watch-435","list-434","read-433","-strong-read-operations-strong--432","delete-collection-431","delete-430","replace-429","patch-428","create-427","-strong-write-operations-strong--426","apiservice-v1-apiregistration-k8s-io","-strong-cluster-strong-","watch-list-425","watch-424","list-423","read-422","-strong-read-operations-strong--421","delete-collection-420","delete-419","replace-418","patch-417","create-416","-strong-write-operations-strong--415","podsecuritypolicy-v1beta1-extensions","watch-list-all-namespaces-414","watch-list-413","watch-412","list-all-namespaces-411","list-410","read-409","-strong-read-operations-strong--408","delete-collection-407","delete-406","replace-405","patch-404","create-403","-strong-write-operations-strong--402","podpreset-v1alpha1-settings-k8s-io","watch-list-401","watch-400","list-399","read-398","-strong-read-operations-strong--397","delete-collection-396","delete-395","replace-394","patch-393","create-392","-strong-write-operations-strong--391","priorityclass-v1beta1-scheduling-k8s-io","replace-status-390","read-status-389","patch-status-388","-strong-status-operations-strong--387","watch-list-all-namespaces-386","watch-list-385","watch-384","list-all-namespaces-383","list-382","read-381","-strong-read-operations-strong--380","delete-collection-379","delete-378","replace-377","patch-376","create-375","-strong-write-operations-strong--374","poddisruptionbudget-v1beta1-policy","watch-list-all-namespaces-373","watch-list-372","watch-371","list-all-namespaces-370","list-369","read-368","-strong-read-operations-strong--367","delete-collection-366","delete-365","replace-364","patch-363","create-362","-strong-write-operations-strong--361","podtemplate-v1-core","watch-list-360","watch-359","list-358","read-357","-strong-read-operations-strong--356","delete-collection-355","delete-354","replace-353","patch-352","create-351","-strong-write-operations-strong--350","validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","watch-list-349","watch-348","list-347","read-346","-strong-read-operations-strong--345","delete-collection-344","delete-343","replace-342","patch-341","create-340","-strong-write-operations-strong--339","mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","watch-list-338","watch-337","list-336","read-335","-strong-read-operations-strong--334","delete-collection-333","delete-332","replace-331","patch-330","create-329","-strong-write-operations-strong--328","initializerconfiguration-v1alpha1-admissionregistration-k8s-io","replace-status-327","read-status-326","patch-status-325","-strong-status-operations-strong--324","watch-list-all-namespaces-323","watch-list-322","watch-321","list-all-namespaces-320","list-319","read-318","-strong-read-operations-strong--317","delete-collection-316","delete-315","replace-314","patch-313","create-312","-strong-write-operations-strong--311","horizontalpodautoscaler-v1-autoscaling","watch-list-all-namespaces-310","watch-list-309","watch-308","list-all-namespaces-307","list-306","read-305","-strong-read-operations-strong--304","delete-collection-303","delete-302","replace-301","patch-300","create-299","-strong-write-operations-strong--298","limitrange-v1-core","watch-list-all-namespaces-297","watch-list-296","watch-295","list-all-namespaces-294","list-293","read-292","-strong-read-operations-strong--291","delete-collection-290","delete-289","replace-288","patch-287","create-286","-strong-write-operations-strong--285","event-v1-core","replace-status-284","read-status-283","patch-status-282","-strong-status-operations-strong--281","watch-list-280","watch-279","list-278","read-277","-strong-read-operations-strong--276","delete-collection-275","delete-274","replace-273","patch-272","create-271","-strong-write-operations-strong--270","customresourcedefinition-v1beta1-apiextensions-k8s-io","watch-list-all-namespaces-269","watch-list-268","watch-267","list-all-namespaces-266","list-265","read-264","-strong-read-operations-strong--263","delete-collection-262","delete-261","replace-260","patch-259","create-258","-strong-write-operations-strong--257","controllerrevision-v1-apps","-strong-metadata-strong-","watch-list-256","watch-255","list-254","read-253","-strong-read-operations-strong--252","delete-collection-251","delete-250","replace-249","patch-248","create-247","-strong-write-operations-strong--246","volumeattachment-v1beta1-storage-k8s-io","volume-v1-core","watch-list-245","watch-244","list-243","read-242","-strong-read-operations-strong--241","delete-collection-240","delete-239","replace-238","patch-237","create-236","-strong-write-operations-strong--235","storageclass-v1-storage-k8s-io","replace-status-234","read-status-233","patch-status-232","-strong-status-operations-strong--231","watch-list-all-namespaces-230","watch-list-229","watch-228","list-all-namespaces-227","list-226","read-225","-strong-read-operations-strong--224","delete-collection-223","delete-222","replace-221","patch-220","create-219","-strong-write-operations-strong--218","persistentvolumeclaim-v1-core","watch-list-all-namespaces-217","watch-list-216","watch-215","list-all-namespaces-214","list-213","read-212","-strong-read-operations-strong--211","delete-collection-210","delete-209","replace-208","patch-207","create-206","-strong-write-operations-strong--205","secret-v1-core","watch-list-all-namespaces-204","watch-list-203","watch-202","list-all-namespaces-201","list-200","read-199","-strong-read-operations-strong--198","delete-collection-197","delete-196","replace-195","patch-194","create-193","-strong-write-operations-strong--192","configmap-v1-core","-strong-config-storage-strong-","replace-connect-proxy-path-191","replace-connect-proxy-190","head-connect-proxy-path-189","head-connect-proxy-188","get-connect-proxy-path-187","get-connect-proxy-186","delete-connect-proxy-path-185","delete-connect-proxy-184","create-connect-proxy-path-183","create-connect-proxy-182","-strong-proxy-operations-strong--181","replace-status-180","read-status-179","patch-status-178","-strong-status-operations-strong--177","watch-list-all-namespaces-176","watch-list-175","watch-174","list-all-namespaces-173","list-172","read-171","-strong-read-operations-strong--170","delete-169","replace-168","patch-167","create-166","-strong-write-operations-strong--165","service-v1-core","replace-status-164","read-status-163","patch-status-162","-strong-status-operations-strong--161","watch-list-all-namespaces-160","watch-list-159","watch-158","list-all-namespaces-157","list-156","read-155","-strong-read-operations-strong--154","delete-collection-153","delete-152","replace-151","patch-150","create-149","-strong-write-operations-strong--148","ingress-v1beta1-extensions","watch-list-all-namespaces-147","watch-list-146","watch-145","list-all-namespaces-144","list-143","read-142","-strong-read-operations-strong--141","delete-collection-140","delete-139","replace-138","patch-137","create-136","-strong-write-operations-strong--135","endpoints-v1-core","-strong-discovery-load-balancing-strong-","patch-scale-134","replace-scale-133","read-scale-132","-strong-misc-operations-strong--131","replace-status-130","read-status-129","patch-status-128","-strong-status-operations-strong--127","watch-list-all-namespaces-126","watch-list-125","watch-124","list-all-namespaces-123","list-122","read-121","-strong-read-operations-strong--120","delete-collection-119","delete-118","replace-117","patch-116","create-115","-strong-write-operations-strong--114","statefulset-v1-apps","patch-scale-113","replace-scale-112","read-scale-111","-strong-misc-operations-strong--110","replace-status-109","read-status-108","patch-status-107","-strong-status-operations-strong--106","watch-list-all-namespaces-105","watch-list-104","watch-103","list-all-namespaces-102","list-101","read-100","-strong-read-operations-strong--99","delete-collection-98","delete-97","replace-96","patch-95","create-94","-strong-write-operations-strong--93","replicationcontroller-v1-core","patch-scale-92","replace-scale-91","read-scale-90","-strong-misc-operations-strong--89","replace-status-88","read-status-87","patch-status-86","-strong-status-operations-strong--85","watch-list-all-namespaces-84","watch-list-83","watch-82","list-all-namespaces-81","list-80","read-79","-strong-read-operations-strong--78","delete-collection-77","delete-76","replace-75","patch-74","create-73","-strong-write-operations-strong--72","replicaset-v1-apps","read-log","-strong-misc-operations-strong--71","replace-connect-proxy-path","replace-connect-proxy","head-connect-proxy-path","head-connect-proxy","get-connect-proxy-path","get-connect-proxy","get-connect-portforward","delete-connect-proxy-path","delete-connect-proxy","create-connect-proxy-path","create-connect-proxy","create-connect-portforward","-strong-proxy-operations-strong-","replace-status-70","read-status-69","patch-status-68","-strong-status-operations-strong--67","watch-list-all-namespaces-66","watch-list-65","watch-64","list-all-namespaces-63","list-62","read-61","-strong-read-operations-strong--60","delete-collection-59","delete-58","replace-57","patch-56","create-eviction","create-55","-strong-write-operations-strong--54","pod-v1-core","replace-status-53","read-status-52","patch-status-51","-strong-status-operations-strong--50","watch-list-all-namespaces-49","watch-list-48","watch-47","list-all-namespaces-46","list-45","read-44","-strong-read-operations-strong--43","delete-collection-42","delete-41","replace-40","patch-39","create-38","-strong-write-operations-strong--37","job-v1-batch","patch-scale","replace-scale","read-scale","-strong-misc-operations-strong-","replace-status-36","read-status-35","patch-status-34","-strong-status-operations-strong--33","watch-list-all-namespaces-32","watch-list-31","watch-30","list-all-namespaces-29","list-28","read-27","-strong-read-operations-strong--26","delete-collection-25","delete-24","replace-23","patch-22","create-21","-strong-write-operations-strong--20","deployment-v1-apps","replace-status-19","read-status-18","patch-status-17","-strong-status-operations-strong--16","watch-list-all-namespaces-15","watch-list-14","watch-13","list-all-namespaces-12","list-11","read-10","-strong-read-operations-strong--9","delete-collection-8","delete-7","replace-6","patch-5","create-4","-strong-write-operations-strong--3","daemonset-v1-apps","replace-status","read-status","patch-status","-strong-status-operations-strong-","watch-list-all-namespaces","watch-list","watch","list-all-namespaces","list","read-2","-strong-read-operations-strong-","delete-collection","delete-1","replace","patch","create","-strong-write-operations-strong-","cronjob-v1beta1-batch","container-v1-core","-strong-workloads-strong-","resource-operations","resource-objects","resource-categories","-strong-api-overview-strong-"]};})(); \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/bootstrap/dist/css/bootstrap.min.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/bootstrap/dist/css/bootstrap.min.css new file mode 100755 index 0000000000000..ed3905e0e0c91 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/bootstrap/dist/css/bootstrap.min.css @@ -0,0 +1,6 @@ +/*! + * Bootstrap v3.3.7 (http://getbootstrap.com) + * Copyright 2011-2016 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + *//*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */html{font-family:sans-serif;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{margin:.67em 0;font-size:2em}mark{color:#000;background:#ff0}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{height:0;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{margin:0;font:inherit;color:inherit}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}input{line-height:normal}input[type=checkbox],input[type=radio]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{padding:.35em .625em .75em;margin:0 2px;border:1px solid silver}legend{padding:0;border:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-spacing:0;border-collapse:collapse}td,th{padding:0}/*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */@media print{*,:after,:before{color:#000!important;text-shadow:none!important;background:0 0!important;-webkit-box-shadow:none!important;box-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="javascript:"]:after,a[href^="#"]:after{content:""}blockquote,pre{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000!important}.label{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered td,.table-bordered th{border:1px solid #ddd!important}}@font-face{font-family:'Glyphicons Halflings';src:url(../fonts/glyphicons-halflings-regular.eot);src:url(../fonts/glyphicons-halflings-regular.eot?#iefix) format('embedded-opentype'),url(../fonts/glyphicons-halflings-regular.woff2) format('woff2'),url(../fonts/glyphicons-halflings-regular.woff) format('woff'),url(../fonts/glyphicons-halflings-regular.ttf) format('truetype'),url(../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular) format('svg')}.glyphicon{position:relative;top:1px;display:inline-block;font-family:'Glyphicons Halflings';font-style:normal;font-weight:400;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.glyphicon-asterisk:before{content:"\002a"}.glyphicon-plus:before{content:"\002b"}.glyphicon-eur:before,.glyphicon-euro:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}.glyphicon-cd:before{content:"\e201"}.glyphicon-save-file:before{content:"\e202"}.glyphicon-open-file:before{content:"\e203"}.glyphicon-level-up:before{content:"\e204"}.glyphicon-copy:before{content:"\e205"}.glyphicon-paste:before{content:"\e206"}.glyphicon-alert:before{content:"\e209"}.glyphicon-equalizer:before{content:"\e210"}.glyphicon-king:before{content:"\e211"}.glyphicon-queen:before{content:"\e212"}.glyphicon-pawn:before{content:"\e213"}.glyphicon-bishop:before{content:"\e214"}.glyphicon-knight:before{content:"\e215"}.glyphicon-baby-formula:before{content:"\e216"}.glyphicon-tent:before{content:"\26fa"}.glyphicon-blackboard:before{content:"\e218"}.glyphicon-bed:before{content:"\e219"}.glyphicon-apple:before{content:"\f8ff"}.glyphicon-erase:before{content:"\e221"}.glyphicon-hourglass:before{content:"\231b"}.glyphicon-lamp:before{content:"\e223"}.glyphicon-duplicate:before{content:"\e224"}.glyphicon-piggy-bank:before{content:"\e225"}.glyphicon-scissors:before{content:"\e226"}.glyphicon-bitcoin:before{content:"\e227"}.glyphicon-btc:before{content:"\e227"}.glyphicon-xbt:before{content:"\e227"}.glyphicon-yen:before{content:"\00a5"}.glyphicon-jpy:before{content:"\00a5"}.glyphicon-ruble:before{content:"\20bd"}.glyphicon-rub:before{content:"\20bd"}.glyphicon-scale:before{content:"\e230"}.glyphicon-ice-lolly:before{content:"\e231"}.glyphicon-ice-lolly-tasted:before{content:"\e232"}.glyphicon-education:before{content:"\e233"}.glyphicon-option-horizontal:before{content:"\e234"}.glyphicon-option-vertical:before{content:"\e235"}.glyphicon-menu-hamburger:before{content:"\e236"}.glyphicon-modal-window:before{content:"\e237"}.glyphicon-oil:before{content:"\e238"}.glyphicon-grain:before{content:"\e239"}.glyphicon-sunglasses:before{content:"\e240"}.glyphicon-text-size:before{content:"\e241"}.glyphicon-text-color:before{content:"\e242"}.glyphicon-text-background:before{content:"\e243"}.glyphicon-object-align-top:before{content:"\e244"}.glyphicon-object-align-bottom:before{content:"\e245"}.glyphicon-object-align-horizontal:before{content:"\e246"}.glyphicon-object-align-left:before{content:"\e247"}.glyphicon-object-align-vertical:before{content:"\e248"}.glyphicon-object-align-right:before{content:"\e249"}.glyphicon-triangle-right:before{content:"\e250"}.glyphicon-triangle-left:before{content:"\e251"}.glyphicon-triangle-bottom:before{content:"\e252"}.glyphicon-triangle-top:before{content:"\e253"}.glyphicon-console:before{content:"\e254"}.glyphicon-superscript:before{content:"\e255"}.glyphicon-subscript:before{content:"\e256"}.glyphicon-menu-left:before{content:"\e257"}.glyphicon-menu-right:before{content:"\e258"}.glyphicon-menu-down:before{content:"\e259"}.glyphicon-menu-up:before{content:"\e260"}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}:after,:before{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:10px;-webkit-tap-highlight-color:rgba(0,0,0,0)}body{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:1.42857143;color:#333;background-color:#fff}button,input,select,textarea{font-family:inherit;font-size:inherit;line-height:inherit}a{color:#337ab7;text-decoration:none}a:focus,a:hover{color:#23527c;text-decoration:underline}a:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}figure{margin:0}img{vertical-align:middle}.carousel-inner>.item>a>img,.carousel-inner>.item>img,.img-responsive,.thumbnail a>img,.thumbnail>img{display:block;max-width:100%;height:auto}.img-rounded{border-radius:6px}.img-thumbnail{display:inline-block;max-width:100%;height:auto;padding:4px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.img-circle{border-radius:50%}hr{margin-top:20px;margin-bottom:20px;border:0;border-top:1px solid #eee}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}[role=button]{cursor:pointer}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6{font-family:inherit;font-weight:500;line-height:1.1;color:inherit}.h1 .small,.h1 small,.h2 .small,.h2 small,.h3 .small,.h3 small,.h4 .small,.h4 small,.h5 .small,.h5 small,.h6 .small,.h6 small,h1 .small,h1 small,h2 .small,h2 small,h3 .small,h3 small,h4 .small,h4 small,h5 .small,h5 small,h6 .small,h6 small{font-weight:400;line-height:1;color:#777}.h1,.h2,.h3,h1,h2,h3{margin-top:20px;margin-bottom:10px}.h1 .small,.h1 small,.h2 .small,.h2 small,.h3 .small,.h3 small,h1 .small,h1 small,h2 .small,h2 small,h3 .small,h3 small{font-size:65%}.h4,.h5,.h6,h4,h5,h6{margin-top:10px;margin-bottom:10px}.h4 .small,.h4 small,.h5 .small,.h5 small,.h6 .small,.h6 small,h4 .small,h4 small,h5 .small,h5 small,h6 .small,h6 small{font-size:75%}.h1,h1{font-size:36px}.h2,h2{font-size:30px}.h3,h3{font-size:24px}.h4,h4{font-size:18px}.h5,h5{font-size:14px}.h6,h6{font-size:12px}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:16px;font-weight:300;line-height:1.4}@media (min-width:768px){.lead{font-size:21px}}.small,small{font-size:85%}.mark,mark{padding:.2em;background-color:#fcf8e3}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}.text-justify{text-align:justify}.text-nowrap{white-space:nowrap}.text-lowercase{text-transform:lowercase}.text-uppercase{text-transform:uppercase}.text-capitalize{text-transform:capitalize}.text-muted{color:#777}.text-primary{color:#337ab7}a.text-primary:focus,a.text-primary:hover{color:#286090}.text-success{color:#3c763d}a.text-success:focus,a.text-success:hover{color:#2b542c}.text-info{color:#31708f}a.text-info:focus,a.text-info:hover{color:#245269}.text-warning{color:#8a6d3b}a.text-warning:focus,a.text-warning:hover{color:#66512c}.text-danger{color:#a94442}a.text-danger:focus,a.text-danger:hover{color:#843534}.bg-primary{color:#fff;background-color:#337ab7}a.bg-primary:focus,a.bg-primary:hover{background-color:#286090}.bg-success{background-color:#dff0d8}a.bg-success:focus,a.bg-success:hover{background-color:#c1e2b3}.bg-info{background-color:#d9edf7}a.bg-info:focus,a.bg-info:hover{background-color:#afd9ee}.bg-warning{background-color:#fcf8e3}a.bg-warning:focus,a.bg-warning:hover{background-color:#f7ecb5}.bg-danger{background-color:#f2dede}a.bg-danger:focus,a.bg-danger:hover{background-color:#e4b9b9}.page-header{padding-bottom:9px;margin:40px 0 20px;border-bottom:1px solid #eee}ol,ul{margin-top:0;margin-bottom:10px}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;margin-left:-5px;list-style:none}.list-inline>li{display:inline-block;padding-right:5px;padding-left:5px}dl{margin-top:0;margin-bottom:20px}dd,dt{line-height:1.42857143}dt{font-weight:700}dd{margin-left:0}@media (min-width:768px){.dl-horizontal dt{float:left;width:160px;overflow:hidden;clear:left;text-align:right;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}}abbr[data-original-title],abbr[title]{cursor:help;border-bottom:1px dotted #777}.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:10px 20px;margin:0 0 20px;font-size:17.5px;border-left:5px solid #eee}blockquote ol:last-child,blockquote p:last-child,blockquote ul:last-child{margin-bottom:0}blockquote .small,blockquote footer,blockquote small{display:block;font-size:80%;line-height:1.42857143;color:#777}blockquote .small:before,blockquote footer:before,blockquote small:before{content:'\2014 \00A0'}.blockquote-reverse,blockquote.pull-right{padding-right:15px;padding-left:0;text-align:right;border-right:5px solid #eee;border-left:0}.blockquote-reverse .small:before,.blockquote-reverse footer:before,.blockquote-reverse small:before,blockquote.pull-right .small:before,blockquote.pull-right footer:before,blockquote.pull-right small:before{content:''}.blockquote-reverse .small:after,.blockquote-reverse footer:after,.blockquote-reverse small:after,blockquote.pull-right .small:after,blockquote.pull-right footer:after,blockquote.pull-right small:after{content:'\00A0 \2014'}address{margin-bottom:20px;font-style:normal;line-height:1.42857143}code,kbd,pre,samp{font-family:Menlo,Monaco,Consolas,"Courier New",monospace}code{padding:2px 4px;font-size:90%;color:#c7254e;background-color:#f9f2f4;border-radius:4px}kbd{padding:2px 4px;font-size:90%;color:#fff;background-color:#333;border-radius:3px;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.25);box-shadow:inset 0 -1px 0 rgba(0,0,0,.25)}kbd kbd{padding:0;font-size:100%;font-weight:700;-webkit-box-shadow:none;box-shadow:none}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.42857143;color:#333;word-break:break-all;word-wrap:break-word;background-color:#f5f5f5;border:1px solid #ccc;border-radius:4px}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}@media (min-width:768px){.container{width:750px}}@media (min-width:992px){.container{width:970px}}@media (min-width:1200px){.container{width:1170px}}.container-fluid{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}.row{margin-right:-15px;margin-left:-15px}.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{position:relative;min-height:1px;padding-right:15px;padding-left:15px}.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{float:left}.col-xs-12{width:100%}.col-xs-11{width:91.66666667%}.col-xs-10{width:83.33333333%}.col-xs-9{width:75%}.col-xs-8{width:66.66666667%}.col-xs-7{width:58.33333333%}.col-xs-6{width:50%}.col-xs-5{width:41.66666667%}.col-xs-4{width:33.33333333%}.col-xs-3{width:25%}.col-xs-2{width:16.66666667%}.col-xs-1{width:8.33333333%}.col-xs-pull-12{right:100%}.col-xs-pull-11{right:91.66666667%}.col-xs-pull-10{right:83.33333333%}.col-xs-pull-9{right:75%}.col-xs-pull-8{right:66.66666667%}.col-xs-pull-7{right:58.33333333%}.col-xs-pull-6{right:50%}.col-xs-pull-5{right:41.66666667%}.col-xs-pull-4{right:33.33333333%}.col-xs-pull-3{right:25%}.col-xs-pull-2{right:16.66666667%}.col-xs-pull-1{right:8.33333333%}.col-xs-pull-0{right:auto}.col-xs-push-12{left:100%}.col-xs-push-11{left:91.66666667%}.col-xs-push-10{left:83.33333333%}.col-xs-push-9{left:75%}.col-xs-push-8{left:66.66666667%}.col-xs-push-7{left:58.33333333%}.col-xs-push-6{left:50%}.col-xs-push-5{left:41.66666667%}.col-xs-push-4{left:33.33333333%}.col-xs-push-3{left:25%}.col-xs-push-2{left:16.66666667%}.col-xs-push-1{left:8.33333333%}.col-xs-push-0{left:auto}.col-xs-offset-12{margin-left:100%}.col-xs-offset-11{margin-left:91.66666667%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-0{margin-left:0}@media (min-width:768px){.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9{float:left}.col-sm-12{width:100%}.col-sm-11{width:91.66666667%}.col-sm-10{width:83.33333333%}.col-sm-9{width:75%}.col-sm-8{width:66.66666667%}.col-sm-7{width:58.33333333%}.col-sm-6{width:50%}.col-sm-5{width:41.66666667%}.col-sm-4{width:33.33333333%}.col-sm-3{width:25%}.col-sm-2{width:16.66666667%}.col-sm-1{width:8.33333333%}.col-sm-pull-12{right:100%}.col-sm-pull-11{right:91.66666667%}.col-sm-pull-10{right:83.33333333%}.col-sm-pull-9{right:75%}.col-sm-pull-8{right:66.66666667%}.col-sm-pull-7{right:58.33333333%}.col-sm-pull-6{right:50%}.col-sm-pull-5{right:41.66666667%}.col-sm-pull-4{right:33.33333333%}.col-sm-pull-3{right:25%}.col-sm-pull-2{right:16.66666667%}.col-sm-pull-1{right:8.33333333%}.col-sm-pull-0{right:auto}.col-sm-push-12{left:100%}.col-sm-push-11{left:91.66666667%}.col-sm-push-10{left:83.33333333%}.col-sm-push-9{left:75%}.col-sm-push-8{left:66.66666667%}.col-sm-push-7{left:58.33333333%}.col-sm-push-6{left:50%}.col-sm-push-5{left:41.66666667%}.col-sm-push-4{left:33.33333333%}.col-sm-push-3{left:25%}.col-sm-push-2{left:16.66666667%}.col-sm-push-1{left:8.33333333%}.col-sm-push-0{left:auto}.col-sm-offset-12{margin-left:100%}.col-sm-offset-11{margin-left:91.66666667%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-0{margin-left:0}}@media (min-width:992px){.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9{float:left}.col-md-12{width:100%}.col-md-11{width:91.66666667%}.col-md-10{width:83.33333333%}.col-md-9{width:75%}.col-md-8{width:66.66666667%}.col-md-7{width:58.33333333%}.col-md-6{width:50%}.col-md-5{width:41.66666667%}.col-md-4{width:33.33333333%}.col-md-3{width:25%}.col-md-2{width:16.66666667%}.col-md-1{width:8.33333333%}.col-md-pull-12{right:100%}.col-md-pull-11{right:91.66666667%}.col-md-pull-10{right:83.33333333%}.col-md-pull-9{right:75%}.col-md-pull-8{right:66.66666667%}.col-md-pull-7{right:58.33333333%}.col-md-pull-6{right:50%}.col-md-pull-5{right:41.66666667%}.col-md-pull-4{right:33.33333333%}.col-md-pull-3{right:25%}.col-md-pull-2{right:16.66666667%}.col-md-pull-1{right:8.33333333%}.col-md-pull-0{right:auto}.col-md-push-12{left:100%}.col-md-push-11{left:91.66666667%}.col-md-push-10{left:83.33333333%}.col-md-push-9{left:75%}.col-md-push-8{left:66.66666667%}.col-md-push-7{left:58.33333333%}.col-md-push-6{left:50%}.col-md-push-5{left:41.66666667%}.col-md-push-4{left:33.33333333%}.col-md-push-3{left:25%}.col-md-push-2{left:16.66666667%}.col-md-push-1{left:8.33333333%}.col-md-push-0{left:auto}.col-md-offset-12{margin-left:100%}.col-md-offset-11{margin-left:91.66666667%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-9{margin-left:75%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-6{margin-left:50%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-3{margin-left:25%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-0{margin-left:0}}@media (min-width:1200px){.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9{float:left}.col-lg-12{width:100%}.col-lg-11{width:91.66666667%}.col-lg-10{width:83.33333333%}.col-lg-9{width:75%}.col-lg-8{width:66.66666667%}.col-lg-7{width:58.33333333%}.col-lg-6{width:50%}.col-lg-5{width:41.66666667%}.col-lg-4{width:33.33333333%}.col-lg-3{width:25%}.col-lg-2{width:16.66666667%}.col-lg-1{width:8.33333333%}.col-lg-pull-12{right:100%}.col-lg-pull-11{right:91.66666667%}.col-lg-pull-10{right:83.33333333%}.col-lg-pull-9{right:75%}.col-lg-pull-8{right:66.66666667%}.col-lg-pull-7{right:58.33333333%}.col-lg-pull-6{right:50%}.col-lg-pull-5{right:41.66666667%}.col-lg-pull-4{right:33.33333333%}.col-lg-pull-3{right:25%}.col-lg-pull-2{right:16.66666667%}.col-lg-pull-1{right:8.33333333%}.col-lg-pull-0{right:auto}.col-lg-push-12{left:100%}.col-lg-push-11{left:91.66666667%}.col-lg-push-10{left:83.33333333%}.col-lg-push-9{left:75%}.col-lg-push-8{left:66.66666667%}.col-lg-push-7{left:58.33333333%}.col-lg-push-6{left:50%}.col-lg-push-5{left:41.66666667%}.col-lg-push-4{left:33.33333333%}.col-lg-push-3{left:25%}.col-lg-push-2{left:16.66666667%}.col-lg-push-1{left:8.33333333%}.col-lg-push-0{left:auto}.col-lg-offset-12{margin-left:100%}.col-lg-offset-11{margin-left:91.66666667%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-0{margin-left:0}}table{background-color:transparent}caption{padding-top:8px;padding-bottom:8px;color:#777;text-align:left}th{text-align:left}.table{width:100%;max-width:100%;margin-bottom:20px}.table>tbody>tr>td,.table>tbody>tr>th,.table>tfoot>tr>td,.table>tfoot>tr>th,.table>thead>tr>td,.table>thead>tr>th{padding:8px;line-height:1.42857143;vertical-align:top;border-top:1px solid #ddd}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #ddd}.table>caption+thead>tr:first-child>td,.table>caption+thead>tr:first-child>th,.table>colgroup+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>td,.table>thead:first-child>tr:first-child>th{border-top:0}.table>tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed>tbody>tr>td,.table-condensed>tbody>tr>th,.table-condensed>tfoot>tr>td,.table-condensed>tfoot>tr>th,.table-condensed>thead>tr>td,.table-condensed>thead>tr>th{padding:5px}.table-bordered{border:1px solid #ddd}.table-bordered>tbody>tr>td,.table-bordered>tbody>tr>th,.table-bordered>tfoot>tr>td,.table-bordered>tfoot>tr>th,.table-bordered>thead>tr>td,.table-bordered>thead>tr>th{border:1px solid #ddd}.table-bordered>thead>tr>td,.table-bordered>thead>tr>th{border-bottom-width:2px}.table-striped>tbody>tr:nth-of-type(odd){background-color:#f9f9f9}.table-hover>tbody>tr:hover{background-color:#f5f5f5}table col[class*=col-]{position:static;display:table-column;float:none}table td[class*=col-],table th[class*=col-]{position:static;display:table-cell;float:none}.table>tbody>tr.active>td,.table>tbody>tr.active>th,.table>tbody>tr>td.active,.table>tbody>tr>th.active,.table>tfoot>tr.active>td,.table>tfoot>tr.active>th,.table>tfoot>tr>td.active,.table>tfoot>tr>th.active,.table>thead>tr.active>td,.table>thead>tr.active>th,.table>thead>tr>td.active,.table>thead>tr>th.active{background-color:#f5f5f5}.table-hover>tbody>tr.active:hover>td,.table-hover>tbody>tr.active:hover>th,.table-hover>tbody>tr:hover>.active,.table-hover>tbody>tr>td.active:hover,.table-hover>tbody>tr>th.active:hover{background-color:#e8e8e8}.table>tbody>tr.success>td,.table>tbody>tr.success>th,.table>tbody>tr>td.success,.table>tbody>tr>th.success,.table>tfoot>tr.success>td,.table>tfoot>tr.success>th,.table>tfoot>tr>td.success,.table>tfoot>tr>th.success,.table>thead>tr.success>td,.table>thead>tr.success>th,.table>thead>tr>td.success,.table>thead>tr>th.success{background-color:#dff0d8}.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr.success:hover>th,.table-hover>tbody>tr:hover>.success,.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover{background-color:#d0e9c6}.table>tbody>tr.info>td,.table>tbody>tr.info>th,.table>tbody>tr>td.info,.table>tbody>tr>th.info,.table>tfoot>tr.info>td,.table>tfoot>tr.info>th,.table>tfoot>tr>td.info,.table>tfoot>tr>th.info,.table>thead>tr.info>td,.table>thead>tr.info>th,.table>thead>tr>td.info,.table>thead>tr>th.info{background-color:#d9edf7}.table-hover>tbody>tr.info:hover>td,.table-hover>tbody>tr.info:hover>th,.table-hover>tbody>tr:hover>.info,.table-hover>tbody>tr>td.info:hover,.table-hover>tbody>tr>th.info:hover{background-color:#c4e3f3}.table>tbody>tr.warning>td,.table>tbody>tr.warning>th,.table>tbody>tr>td.warning,.table>tbody>tr>th.warning,.table>tfoot>tr.warning>td,.table>tfoot>tr.warning>th,.table>tfoot>tr>td.warning,.table>tfoot>tr>th.warning,.table>thead>tr.warning>td,.table>thead>tr.warning>th,.table>thead>tr>td.warning,.table>thead>tr>th.warning{background-color:#fcf8e3}.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr.warning:hover>th,.table-hover>tbody>tr:hover>.warning,.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover{background-color:#faf2cc}.table>tbody>tr.danger>td,.table>tbody>tr.danger>th,.table>tbody>tr>td.danger,.table>tbody>tr>th.danger,.table>tfoot>tr.danger>td,.table>tfoot>tr.danger>th,.table>tfoot>tr>td.danger,.table>tfoot>tr>th.danger,.table>thead>tr.danger>td,.table>thead>tr.danger>th,.table>thead>tr>td.danger,.table>thead>tr>th.danger{background-color:#f2dede}.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr.danger:hover>th,.table-hover>tbody>tr:hover>.danger,.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover{background-color:#ebcccc}.table-responsive{min-height:.01%;overflow-x:auto}@media screen and (max-width:767px){.table-responsive{width:100%;margin-bottom:15px;overflow-y:hidden;-ms-overflow-style:-ms-autohiding-scrollbar;border:1px solid #ddd}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>tfoot>tr>td,.table-responsive>.table>tfoot>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>thead>tr>th{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>thead>tr>th:first-child{border-left:0}.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>thead>tr>th:last-child{border-right:0}.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tbody>tr:last-child>th,.table-responsive>.table-bordered>tfoot>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}}fieldset{min-width:0;padding:0;margin:0;border:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:inherit;color:#333;border:0;border-bottom:1px solid #e5e5e5}label{display:inline-block;max-width:100%;margin-bottom:5px;font-weight:700}input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=checkbox],input[type=radio]{margin:4px 0 0;margin-top:1px\9;line-height:normal}input[type=file]{display:block}input[type=range]{display:block;width:100%}select[multiple],select[size]{height:auto}input[type=file]:focus,input[type=checkbox]:focus,input[type=radio]:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}output{display:block;padding-top:7px;font-size:14px;line-height:1.42857143;color:#555}.form-control{display:block;width:100%;height:34px;padding:6px 12px;font-size:14px;line-height:1.42857143;color:#555;background-color:#fff;background-image:none;border:1px solid #ccc;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075);-webkit-transition:border-color ease-in-out .15s,-webkit-box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s}.form-control:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6);box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6)}.form-control::-moz-placeholder{color:#999;opacity:1}.form-control:-ms-input-placeholder{color:#999}.form-control::-webkit-input-placeholder{color:#999}.form-control::-ms-expand{background-color:transparent;border:0}.form-control[disabled],.form-control[readonly],fieldset[disabled] .form-control{background-color:#eee;opacity:1}.form-control[disabled],fieldset[disabled] .form-control{cursor:not-allowed}textarea.form-control{height:auto}input[type=search]{-webkit-appearance:none}@media screen and (-webkit-min-device-pixel-ratio:0){input[type=date].form-control,input[type=time].form-control,input[type=datetime-local].form-control,input[type=month].form-control{line-height:34px}.input-group-sm input[type=date],.input-group-sm input[type=time],.input-group-sm input[type=datetime-local],.input-group-sm input[type=month],input[type=date].input-sm,input[type=time].input-sm,input[type=datetime-local].input-sm,input[type=month].input-sm{line-height:30px}.input-group-lg input[type=date],.input-group-lg input[type=time],.input-group-lg input[type=datetime-local],.input-group-lg input[type=month],input[type=date].input-lg,input[type=time].input-lg,input[type=datetime-local].input-lg,input[type=month].input-lg{line-height:46px}}.form-group{margin-bottom:15px}.checkbox,.radio{position:relative;display:block;margin-top:10px;margin-bottom:10px}.checkbox label,.radio label{min-height:20px;padding-left:20px;margin-bottom:0;font-weight:400;cursor:pointer}.checkbox input[type=checkbox],.checkbox-inline input[type=checkbox],.radio input[type=radio],.radio-inline input[type=radio]{position:absolute;margin-top:4px\9;margin-left:-20px}.checkbox+.checkbox,.radio+.radio{margin-top:-5px}.checkbox-inline,.radio-inline{position:relative;display:inline-block;padding-left:20px;margin-bottom:0;font-weight:400;vertical-align:middle;cursor:pointer}.checkbox-inline+.checkbox-inline,.radio-inline+.radio-inline{margin-top:0;margin-left:10px}fieldset[disabled] input[type=checkbox],fieldset[disabled] input[type=radio],input[type=checkbox].disabled,input[type=checkbox][disabled],input[type=radio].disabled,input[type=radio][disabled]{cursor:not-allowed}.checkbox-inline.disabled,.radio-inline.disabled,fieldset[disabled] .checkbox-inline,fieldset[disabled] .radio-inline{cursor:not-allowed}.checkbox.disabled label,.radio.disabled label,fieldset[disabled] .checkbox label,fieldset[disabled] .radio label{cursor:not-allowed}.form-control-static{min-height:34px;padding-top:7px;padding-bottom:7px;margin-bottom:0}.form-control-static.input-lg,.form-control-static.input-sm{padding-right:0;padding-left:0}.input-sm{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-sm{height:30px;line-height:30px}select[multiple].input-sm,textarea.input-sm{height:auto}.form-group-sm .form-control{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.form-group-sm select.form-control{height:30px;line-height:30px}.form-group-sm select[multiple].form-control,.form-group-sm textarea.form-control{height:auto}.form-group-sm .form-control-static{height:30px;min-height:32px;padding:6px 10px;font-size:12px;line-height:1.5}.input-lg{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-lg{height:46px;line-height:46px}select[multiple].input-lg,textarea.input-lg{height:auto}.form-group-lg .form-control{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.form-group-lg select.form-control{height:46px;line-height:46px}.form-group-lg select[multiple].form-control,.form-group-lg textarea.form-control{height:auto}.form-group-lg .form-control-static{height:46px;min-height:38px;padding:11px 16px;font-size:18px;line-height:1.3333333}.has-feedback{position:relative}.has-feedback .form-control{padding-right:42.5px}.form-control-feedback{position:absolute;top:0;right:0;z-index:2;display:block;width:34px;height:34px;line-height:34px;text-align:center;pointer-events:none}.form-group-lg .form-control+.form-control-feedback,.input-group-lg+.form-control-feedback,.input-lg+.form-control-feedback{width:46px;height:46px;line-height:46px}.form-group-sm .form-control+.form-control-feedback,.input-group-sm+.form-control-feedback,.input-sm+.form-control-feedback{width:30px;height:30px;line-height:30px}.has-success .checkbox,.has-success .checkbox-inline,.has-success .control-label,.has-success .help-block,.has-success .radio,.has-success .radio-inline,.has-success.checkbox label,.has-success.checkbox-inline label,.has-success.radio label,.has-success.radio-inline label{color:#3c763d}.has-success .form-control{border-color:#3c763d;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-success .form-control:focus{border-color:#2b542c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168}.has-success .input-group-addon{color:#3c763d;background-color:#dff0d8;border-color:#3c763d}.has-success .form-control-feedback{color:#3c763d}.has-warning .checkbox,.has-warning .checkbox-inline,.has-warning .control-label,.has-warning .help-block,.has-warning .radio,.has-warning .radio-inline,.has-warning.checkbox label,.has-warning.checkbox-inline label,.has-warning.radio label,.has-warning.radio-inline label{color:#8a6d3b}.has-warning .form-control{border-color:#8a6d3b;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-warning .form-control:focus{border-color:#66512c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b}.has-warning .input-group-addon{color:#8a6d3b;background-color:#fcf8e3;border-color:#8a6d3b}.has-warning .form-control-feedback{color:#8a6d3b}.has-error .checkbox,.has-error .checkbox-inline,.has-error .control-label,.has-error .help-block,.has-error .radio,.has-error .radio-inline,.has-error.checkbox label,.has-error.checkbox-inline label,.has-error.radio label,.has-error.radio-inline label{color:#a94442}.has-error .form-control{border-color:#a94442;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-error .form-control:focus{border-color:#843534;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483}.has-error .input-group-addon{color:#a94442;background-color:#f2dede;border-color:#a94442}.has-error .form-control-feedback{color:#a94442}.has-feedback label~.form-control-feedback{top:25px}.has-feedback label.sr-only~.form-control-feedback{top:0}.help-block{display:block;margin-top:5px;margin-bottom:10px;color:#737373}@media (min-width:768px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-static{display:inline-block}.form-inline .input-group{display:inline-table;vertical-align:middle}.form-inline .input-group .form-control,.form-inline .input-group .input-group-addon,.form-inline .input-group .input-group-btn{width:auto}.form-inline .input-group>.form-control{width:100%}.form-inline .control-label{margin-bottom:0;vertical-align:middle}.form-inline .checkbox,.form-inline .radio{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.form-inline .checkbox label,.form-inline .radio label{padding-left:0}.form-inline .checkbox input[type=checkbox],.form-inline .radio input[type=radio]{position:relative;margin-left:0}.form-inline .has-feedback .form-control-feedback{top:0}}.form-horizontal .checkbox,.form-horizontal .checkbox-inline,.form-horizontal .radio,.form-horizontal .radio-inline{padding-top:7px;margin-top:0;margin-bottom:0}.form-horizontal .checkbox,.form-horizontal .radio{min-height:27px}.form-horizontal .form-group{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.form-horizontal .control-label{padding-top:7px;margin-bottom:0;text-align:right}}.form-horizontal .has-feedback .form-control-feedback{right:15px}@media (min-width:768px){.form-horizontal .form-group-lg .control-label{padding-top:11px;font-size:18px}}@media (min-width:768px){.form-horizontal .form-group-sm .control-label{padding-top:6px;font-size:12px}}.btn{display:inline-block;padding:6px 12px;margin-bottom:0;font-size:14px;font-weight:400;line-height:1.42857143;text-align:center;white-space:nowrap;vertical-align:middle;-ms-touch-action:manipulation;touch-action:manipulation;cursor:pointer;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-image:none;border:1px solid transparent;border-radius:4px}.btn.active.focus,.btn.active:focus,.btn.focus,.btn:active.focus,.btn:active:focus,.btn:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn.focus,.btn:focus,.btn:hover{color:#333;text-decoration:none}.btn.active,.btn:active{background-image:none;outline:0;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px rgba(0,0,0,.125)}.btn.disabled,.btn[disabled],fieldset[disabled] .btn{cursor:not-allowed;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none;opacity:.65}a.btn.disabled,fieldset[disabled] a.btn{pointer-events:none}.btn-default{color:#333;background-color:#fff;border-color:#ccc}.btn-default.focus,.btn-default:focus{color:#333;background-color:#e6e6e6;border-color:#8c8c8c}.btn-default:hover{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default.active,.btn-default:active,.open>.dropdown-toggle.btn-default{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default.active.focus,.btn-default.active:focus,.btn-default.active:hover,.btn-default:active.focus,.btn-default:active:focus,.btn-default:active:hover,.open>.dropdown-toggle.btn-default.focus,.open>.dropdown-toggle.btn-default:focus,.open>.dropdown-toggle.btn-default:hover{color:#333;background-color:#d4d4d4;border-color:#8c8c8c}.btn-default.active,.btn-default:active,.open>.dropdown-toggle.btn-default{background-image:none}.btn-default.disabled.focus,.btn-default.disabled:focus,.btn-default.disabled:hover,.btn-default[disabled].focus,.btn-default[disabled]:focus,.btn-default[disabled]:hover,fieldset[disabled] .btn-default.focus,fieldset[disabled] .btn-default:focus,fieldset[disabled] .btn-default:hover{background-color:#fff;border-color:#ccc}.btn-default .badge{color:#fff;background-color:#333}.btn-primary{color:#fff;background-color:#337ab7;border-color:#2e6da4}.btn-primary.focus,.btn-primary:focus{color:#fff;background-color:#286090;border-color:#122b40}.btn-primary:hover{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary.active,.btn-primary:active,.open>.dropdown-toggle.btn-primary{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary.active.focus,.btn-primary.active:focus,.btn-primary.active:hover,.btn-primary:active.focus,.btn-primary:active:focus,.btn-primary:active:hover,.open>.dropdown-toggle.btn-primary.focus,.open>.dropdown-toggle.btn-primary:focus,.open>.dropdown-toggle.btn-primary:hover{color:#fff;background-color:#204d74;border-color:#122b40}.btn-primary.active,.btn-primary:active,.open>.dropdown-toggle.btn-primary{background-image:none}.btn-primary.disabled.focus,.btn-primary.disabled:focus,.btn-primary.disabled:hover,.btn-primary[disabled].focus,.btn-primary[disabled]:focus,.btn-primary[disabled]:hover,fieldset[disabled] .btn-primary.focus,fieldset[disabled] .btn-primary:focus,fieldset[disabled] .btn-primary:hover{background-color:#337ab7;border-color:#2e6da4}.btn-primary .badge{color:#337ab7;background-color:#fff}.btn-success{color:#fff;background-color:#5cb85c;border-color:#4cae4c}.btn-success.focus,.btn-success:focus{color:#fff;background-color:#449d44;border-color:#255625}.btn-success:hover{color:#fff;background-color:#449d44;border-color:#398439}.btn-success.active,.btn-success:active,.open>.dropdown-toggle.btn-success{color:#fff;background-color:#449d44;border-color:#398439}.btn-success.active.focus,.btn-success.active:focus,.btn-success.active:hover,.btn-success:active.focus,.btn-success:active:focus,.btn-success:active:hover,.open>.dropdown-toggle.btn-success.focus,.open>.dropdown-toggle.btn-success:focus,.open>.dropdown-toggle.btn-success:hover{color:#fff;background-color:#398439;border-color:#255625}.btn-success.active,.btn-success:active,.open>.dropdown-toggle.btn-success{background-image:none}.btn-success.disabled.focus,.btn-success.disabled:focus,.btn-success.disabled:hover,.btn-success[disabled].focus,.btn-success[disabled]:focus,.btn-success[disabled]:hover,fieldset[disabled] .btn-success.focus,fieldset[disabled] .btn-success:focus,fieldset[disabled] .btn-success:hover{background-color:#5cb85c;border-color:#4cae4c}.btn-success .badge{color:#5cb85c;background-color:#fff}.btn-info{color:#fff;background-color:#5bc0de;border-color:#46b8da}.btn-info.focus,.btn-info:focus{color:#fff;background-color:#31b0d5;border-color:#1b6d85}.btn-info:hover{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info.active,.btn-info:active,.open>.dropdown-toggle.btn-info{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info.active.focus,.btn-info.active:focus,.btn-info.active:hover,.btn-info:active.focus,.btn-info:active:focus,.btn-info:active:hover,.open>.dropdown-toggle.btn-info.focus,.open>.dropdown-toggle.btn-info:focus,.open>.dropdown-toggle.btn-info:hover{color:#fff;background-color:#269abc;border-color:#1b6d85}.btn-info.active,.btn-info:active,.open>.dropdown-toggle.btn-info{background-image:none}.btn-info.disabled.focus,.btn-info.disabled:focus,.btn-info.disabled:hover,.btn-info[disabled].focus,.btn-info[disabled]:focus,.btn-info[disabled]:hover,fieldset[disabled] .btn-info.focus,fieldset[disabled] .btn-info:focus,fieldset[disabled] .btn-info:hover{background-color:#5bc0de;border-color:#46b8da}.btn-info .badge{color:#5bc0de;background-color:#fff}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#eea236}.btn-warning.focus,.btn-warning:focus{color:#fff;background-color:#ec971f;border-color:#985f0d}.btn-warning:hover{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning.active,.btn-warning:active,.open>.dropdown-toggle.btn-warning{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning.active.focus,.btn-warning.active:focus,.btn-warning.active:hover,.btn-warning:active.focus,.btn-warning:active:focus,.btn-warning:active:hover,.open>.dropdown-toggle.btn-warning.focus,.open>.dropdown-toggle.btn-warning:focus,.open>.dropdown-toggle.btn-warning:hover{color:#fff;background-color:#d58512;border-color:#985f0d}.btn-warning.active,.btn-warning:active,.open>.dropdown-toggle.btn-warning{background-image:none}.btn-warning.disabled.focus,.btn-warning.disabled:focus,.btn-warning.disabled:hover,.btn-warning[disabled].focus,.btn-warning[disabled]:focus,.btn-warning[disabled]:hover,fieldset[disabled] .btn-warning.focus,fieldset[disabled] .btn-warning:focus,fieldset[disabled] .btn-warning:hover{background-color:#f0ad4e;border-color:#eea236}.btn-warning .badge{color:#f0ad4e;background-color:#fff}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d43f3a}.btn-danger.focus,.btn-danger:focus{color:#fff;background-color:#c9302c;border-color:#761c19}.btn-danger:hover{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger.active,.btn-danger:active,.open>.dropdown-toggle.btn-danger{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger.active.focus,.btn-danger.active:focus,.btn-danger.active:hover,.btn-danger:active.focus,.btn-danger:active:focus,.btn-danger:active:hover,.open>.dropdown-toggle.btn-danger.focus,.open>.dropdown-toggle.btn-danger:focus,.open>.dropdown-toggle.btn-danger:hover{color:#fff;background-color:#ac2925;border-color:#761c19}.btn-danger.active,.btn-danger:active,.open>.dropdown-toggle.btn-danger{background-image:none}.btn-danger.disabled.focus,.btn-danger.disabled:focus,.btn-danger.disabled:hover,.btn-danger[disabled].focus,.btn-danger[disabled]:focus,.btn-danger[disabled]:hover,fieldset[disabled] .btn-danger.focus,fieldset[disabled] .btn-danger:focus,fieldset[disabled] .btn-danger:hover{background-color:#d9534f;border-color:#d43f3a}.btn-danger .badge{color:#d9534f;background-color:#fff}.btn-link{font-weight:400;color:#337ab7;border-radius:0}.btn-link,.btn-link.active,.btn-link:active,.btn-link[disabled],fieldset[disabled] .btn-link{background-color:transparent;-webkit-box-shadow:none;box-shadow:none}.btn-link,.btn-link:active,.btn-link:focus,.btn-link:hover{border-color:transparent}.btn-link:focus,.btn-link:hover{color:#23527c;text-decoration:underline;background-color:transparent}.btn-link[disabled]:focus,.btn-link[disabled]:hover,fieldset[disabled] .btn-link:focus,fieldset[disabled] .btn-link:hover{color:#777;text-decoration:none}.btn-group-lg>.btn,.btn-lg{padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.btn-group-sm>.btn,.btn-sm{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-group-xs>.btn,.btn-xs{padding:1px 5px;font-size:12px;line-height:1.5;border-radius:3px}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:5px}input[type=button].btn-block,input[type=reset].btn-block,input[type=submit].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none}.collapse.in{display:block}tr.collapse.in{display:table-row}tbody.collapse.in{display:table-row-group}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition-timing-function:ease;-o-transition-timing-function:ease;transition-timing-function:ease;-webkit-transition-duration:.35s;-o-transition-duration:.35s;transition-duration:.35s;-webkit-transition-property:height,visibility;-o-transition-property:height,visibility;transition-property:height,visibility}.caret{display:inline-block;width:0;height:0;margin-left:2px;vertical-align:middle;border-top:4px dashed;border-top:4px solid\9;border-right:4px solid transparent;border-left:4px solid transparent}.dropdown,.dropup{position:relative}.dropdown-toggle:focus{outline:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;font-size:14px;text-align:left;list-style:none;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.15);border-radius:4px;-webkit-box-shadow:0 6px 12px rgba(0,0,0,.175);box-shadow:0 6px 12px rgba(0,0,0,.175)}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.dropdown-menu>li>a{display:block;padding:3px 20px;clear:both;font-weight:400;line-height:1.42857143;color:#333;white-space:nowrap}.dropdown-menu>li>a:focus,.dropdown-menu>li>a:hover{color:#262626;text-decoration:none;background-color:#f5f5f5}.dropdown-menu>.active>a,.dropdown-menu>.active>a:focus,.dropdown-menu>.active>a:hover{color:#fff;text-decoration:none;background-color:#337ab7;outline:0}.dropdown-menu>.disabled>a,.dropdown-menu>.disabled>a:focus,.dropdown-menu>.disabled>a:hover{color:#777}.dropdown-menu>.disabled>a:focus,.dropdown-menu>.disabled>a:hover{text-decoration:none;cursor:not-allowed;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-menu-right{right:0;left:auto}.dropdown-menu-left{right:auto;left:0}.dropdown-header{display:block;padding:3px 20px;font-size:12px;line-height:1.42857143;color:#777;white-space:nowrap}.dropdown-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:990}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{content:"";border-top:0;border-bottom:4px dashed;border-bottom:4px solid\9}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:2px}@media (min-width:768px){.navbar-right .dropdown-menu{right:0;left:auto}.navbar-right .dropdown-menu-left{right:auto;left:0}}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group-vertical>.btn,.btn-group>.btn{position:relative;float:left}.btn-group-vertical>.btn.active,.btn-group-vertical>.btn:active,.btn-group-vertical>.btn:focus,.btn-group-vertical>.btn:hover,.btn-group>.btn.active,.btn-group>.btn:active,.btn-group>.btn:focus,.btn-group>.btn:hover{z-index:2}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar{margin-left:-5px}.btn-toolbar .btn,.btn-toolbar .btn-group,.btn-toolbar .input-group{float:left}.btn-toolbar>.btn,.btn-toolbar>.btn-group,.btn-toolbar>.input-group{margin-left:5px}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-bottom-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group>.btn+.dropdown-toggle{padding-right:8px;padding-left:8px}.btn-group>.btn-lg+.dropdown-toggle{padding-right:12px;padding-left:12px}.btn-group.open .dropdown-toggle{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px rgba(0,0,0,.125)}.btn-group.open .dropdown-toggle.btn-link{-webkit-box-shadow:none;box-shadow:none}.btn .caret{margin-left:0}.btn-lg .caret{border-width:5px 5px 0;border-bottom-width:0}.dropup .btn-lg .caret{border-width:0 5px 5px}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group,.btn-group-vertical>.btn-group>.btn{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-top-left-radius:4px;border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn:last-child:not(:first-child){border-top-left-radius:0;border-top-right-radius:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group-vertical>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-top-right-radius:0}.btn-group-justified{display:table;width:100%;table-layout:fixed;border-collapse:separate}.btn-group-justified>.btn,.btn-group-justified>.btn-group{display:table-cell;float:none;width:1%}.btn-group-justified>.btn-group .btn{width:100%}.btn-group-justified>.btn-group .dropdown-menu{left:auto}[data-toggle=buttons]>.btn input[type=checkbox],[data-toggle=buttons]>.btn input[type=radio],[data-toggle=buttons]>.btn-group>.btn input[type=checkbox],[data-toggle=buttons]>.btn-group>.btn input[type=radio]{position:absolute;clip:rect(0,0,0,0);pointer-events:none}.input-group{position:relative;display:table;border-collapse:separate}.input-group[class*=col-]{float:none;padding-right:0;padding-left:0}.input-group .form-control{position:relative;z-index:2;float:left;width:100%;margin-bottom:0}.input-group .form-control:focus{z-index:3}.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-group-lg>.form-control,select.input-group-lg>.input-group-addon,select.input-group-lg>.input-group-btn>.btn{height:46px;line-height:46px}select[multiple].input-group-lg>.form-control,select[multiple].input-group-lg>.input-group-addon,select[multiple].input-group-lg>.input-group-btn>.btn,textarea.input-group-lg>.form-control,textarea.input-group-lg>.input-group-addon,textarea.input-group-lg>.input-group-btn>.btn{height:auto}.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-group-sm>.form-control,select.input-group-sm>.input-group-addon,select.input-group-sm>.input-group-btn>.btn{height:30px;line-height:30px}select[multiple].input-group-sm>.form-control,select[multiple].input-group-sm>.input-group-addon,select[multiple].input-group-sm>.input-group-btn>.btn,textarea.input-group-sm>.form-control,textarea.input-group-sm>.input-group-addon,textarea.input-group-sm>.input-group-btn>.btn{height:auto}.input-group .form-control,.input-group-addon,.input-group-btn{display:table-cell}.input-group .form-control:not(:first-child):not(:last-child),.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:6px 12px;font-size:14px;font-weight:400;line-height:1;color:#555;text-align:center;background-color:#eee;border:1px solid #ccc;border-radius:4px}.input-group-addon.input-sm{padding:5px 10px;font-size:12px;border-radius:3px}.input-group-addon.input-lg{padding:10px 16px;font-size:18px;border-radius:6px}.input-group-addon input[type=checkbox],.input-group-addon input[type=radio]{margin-top:0}.input-group .form-control:first-child,.input-group-addon:first-child,.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group>.btn,.input-group-btn:first-child>.dropdown-toggle,.input-group-btn:last-child>.btn-group:not(:last-child)>.btn,.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.input-group-addon:first-child{border-right:0}.input-group .form-control:last-child,.input-group-addon:last-child,.input-group-btn:first-child>.btn-group:not(:first-child)>.btn,.input-group-btn:first-child>.btn:not(:first-child),.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group>.btn,.input-group-btn:last-child>.dropdown-toggle{border-top-left-radius:0;border-bottom-left-radius:0}.input-group-addon:last-child{border-left:0}.input-group-btn{position:relative;font-size:0;white-space:nowrap}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-1px}.input-group-btn>.btn:active,.input-group-btn>.btn:focus,.input-group-btn>.btn:hover{z-index:2}.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group{margin-right:-1px}.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group{z-index:2;margin-left:-1px}.nav{padding-left:0;margin-bottom:0;list-style:none}.nav>li{position:relative;display:block}.nav>li>a{position:relative;display:block;padding:10px 15px}.nav>li>a:focus,.nav>li>a:hover{text-decoration:none;background-color:#eee}.nav>li.disabled>a{color:#777}.nav>li.disabled>a:focus,.nav>li.disabled>a:hover{color:#777;text-decoration:none;cursor:not-allowed;background-color:transparent}.nav .open>a,.nav .open>a:focus,.nav .open>a:hover{background-color:#eee;border-color:#337ab7}.nav .nav-divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.nav>li>a>img{max-width:none}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{float:left;margin-bottom:-1px}.nav-tabs>li>a{margin-right:2px;line-height:1.42857143;border:1px solid transparent;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eee #eee #ddd}.nav-tabs>li.active>a,.nav-tabs>li.active>a:focus,.nav-tabs>li.active>a:hover{color:#555;cursor:default;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent}.nav-tabs.nav-justified{width:100%;border-bottom:0}.nav-tabs.nav-justified>li{float:none}.nav-tabs.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-tabs.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-tabs.nav-justified>li{display:table-cell;width:1%}.nav-tabs.nav-justified>li>a{margin-bottom:0}}.nav-tabs.nav-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:focus,.nav-tabs.nav-justified>.active>a:hover{border:1px solid #ddd}@media (min-width:768px){.nav-tabs.nav-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:focus,.nav-tabs.nav-justified>.active>a:hover{border-bottom-color:#fff}}.nav-pills>li{float:left}.nav-pills>li>a{border-radius:4px}.nav-pills>li+li{margin-left:2px}.nav-pills>li.active>a,.nav-pills>li.active>a:focus,.nav-pills>li.active>a:hover{color:#fff;background-color:#337ab7}.nav-stacked>li{float:none}.nav-stacked>li+li{margin-top:2px;margin-left:0}.nav-justified{width:100%}.nav-justified>li{float:none}.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-justified>li{display:table-cell;width:1%}.nav-justified>li>a{margin-bottom:0}}.nav-tabs-justified{border-bottom:0}.nav-tabs-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:focus,.nav-tabs-justified>.active>a:hover{border:1px solid #ddd}@media (min-width:768px){.nav-tabs-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:focus,.nav-tabs-justified>.active>a:hover{border-bottom-color:#fff}}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-left-radius:0;border-top-right-radius:0}.navbar{position:relative;min-height:50px;margin-bottom:20px;border:1px solid transparent}@media (min-width:768px){.navbar{border-radius:4px}}@media (min-width:768px){.navbar-header{float:left}}.navbar-collapse{padding-right:15px;padding-left:15px;overflow-x:visible;-webkit-overflow-scrolling:touch;border-top:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px 0 rgba(255,255,255,.1)}.navbar-collapse.in{overflow-y:auto}@media (min-width:768px){.navbar-collapse{width:auto;border-top:0;-webkit-box-shadow:none;box-shadow:none}.navbar-collapse.collapse{display:block!important;height:auto!important;padding-bottom:0;overflow:visible!important}.navbar-collapse.in{overflow-y:visible}.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse,.navbar-static-top .navbar-collapse{padding-right:0;padding-left:0}}.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse{max-height:340px}@media (max-device-width:480px) and (orientation:landscape){.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse{max-height:200px}}.container-fluid>.navbar-collapse,.container-fluid>.navbar-header,.container>.navbar-collapse,.container>.navbar-header{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.container-fluid>.navbar-collapse,.container-fluid>.navbar-header,.container>.navbar-collapse,.container>.navbar-header{margin-right:0;margin-left:0}}.navbar-static-top{z-index:1000;border-width:0 0 1px}@media (min-width:768px){.navbar-static-top{border-radius:0}}.navbar-fixed-bottom,.navbar-fixed-top{position:fixed;right:0;left:0;z-index:1030}@media (min-width:768px){.navbar-fixed-bottom,.navbar-fixed-top{border-radius:0}}.navbar-fixed-top{top:0;border-width:0 0 1px}.navbar-fixed-bottom{bottom:0;margin-bottom:0;border-width:1px 0 0}.navbar-brand{float:left;height:50px;padding:15px 15px;font-size:18px;line-height:20px}.navbar-brand:focus,.navbar-brand:hover{text-decoration:none}.navbar-brand>img{display:block}@media (min-width:768px){.navbar>.container .navbar-brand,.navbar>.container-fluid .navbar-brand{margin-left:-15px}}.navbar-toggle{position:relative;float:right;padding:9px 10px;margin-top:8px;margin-right:15px;margin-bottom:8px;background-color:transparent;background-image:none;border:1px solid transparent;border-radius:4px}.navbar-toggle:focus{outline:0}.navbar-toggle .icon-bar{display:block;width:22px;height:2px;border-radius:1px}.navbar-toggle .icon-bar+.icon-bar{margin-top:4px}@media (min-width:768px){.navbar-toggle{display:none}}.navbar-nav{margin:7.5px -15px}.navbar-nav>li>a{padding-top:10px;padding-bottom:10px;line-height:20px}@media (max-width:767px){.navbar-nav .open .dropdown-menu{position:static;float:none;width:auto;margin-top:0;background-color:transparent;border:0;-webkit-box-shadow:none;box-shadow:none}.navbar-nav .open .dropdown-menu .dropdown-header,.navbar-nav .open .dropdown-menu>li>a{padding:5px 15px 5px 25px}.navbar-nav .open .dropdown-menu>li>a{line-height:20px}.navbar-nav .open .dropdown-menu>li>a:focus,.navbar-nav .open .dropdown-menu>li>a:hover{background-image:none}}@media (min-width:768px){.navbar-nav{float:left;margin:0}.navbar-nav>li{float:left}.navbar-nav>li>a{padding-top:15px;padding-bottom:15px}}.navbar-form{padding:10px 15px;margin-top:8px;margin-right:-15px;margin-bottom:8px;margin-left:-15px;border-top:1px solid transparent;border-bottom:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1)}@media (min-width:768px){.navbar-form .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.navbar-form .form-control{display:inline-block;width:auto;vertical-align:middle}.navbar-form .form-control-static{display:inline-block}.navbar-form .input-group{display:inline-table;vertical-align:middle}.navbar-form .input-group .form-control,.navbar-form .input-group .input-group-addon,.navbar-form .input-group .input-group-btn{width:auto}.navbar-form .input-group>.form-control{width:100%}.navbar-form .control-label{margin-bottom:0;vertical-align:middle}.navbar-form .checkbox,.navbar-form .radio{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.navbar-form .checkbox label,.navbar-form .radio label{padding-left:0}.navbar-form .checkbox input[type=checkbox],.navbar-form .radio input[type=radio]{position:relative;margin-left:0}.navbar-form .has-feedback .form-control-feedback{top:0}}@media (max-width:767px){.navbar-form .form-group{margin-bottom:5px}.navbar-form .form-group:last-child{margin-bottom:0}}@media (min-width:768px){.navbar-form{width:auto;padding-top:0;padding-bottom:0;margin-right:0;margin-left:0;border:0;-webkit-box-shadow:none;box-shadow:none}}.navbar-nav>li>.dropdown-menu{margin-top:0;border-top-left-radius:0;border-top-right-radius:0}.navbar-fixed-bottom .navbar-nav>li>.dropdown-menu{margin-bottom:0;border-top-left-radius:4px;border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.navbar-btn{margin-top:8px;margin-bottom:8px}.navbar-btn.btn-sm{margin-top:10px;margin-bottom:10px}.navbar-btn.btn-xs{margin-top:14px;margin-bottom:14px}.navbar-text{margin-top:15px;margin-bottom:15px}@media (min-width:768px){.navbar-text{float:left;margin-right:15px;margin-left:15px}}@media (min-width:768px){.navbar-left{float:left!important}.navbar-right{float:right!important;margin-right:-15px}.navbar-right~.navbar-right{margin-right:0}}.navbar-default{background-color:#f8f8f8;border-color:#e7e7e7}.navbar-default .navbar-brand{color:#777}.navbar-default .navbar-brand:focus,.navbar-default .navbar-brand:hover{color:#5e5e5e;background-color:transparent}.navbar-default .navbar-text{color:#777}.navbar-default .navbar-nav>li>a{color:#777}.navbar-default .navbar-nav>li>a:focus,.navbar-default .navbar-nav>li>a:hover{color:#333;background-color:transparent}.navbar-default .navbar-nav>.active>a,.navbar-default .navbar-nav>.active>a:focus,.navbar-default .navbar-nav>.active>a:hover{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.disabled>a,.navbar-default .navbar-nav>.disabled>a:focus,.navbar-default .navbar-nav>.disabled>a:hover{color:#ccc;background-color:transparent}.navbar-default .navbar-toggle{border-color:#ddd}.navbar-default .navbar-toggle:focus,.navbar-default .navbar-toggle:hover{background-color:#ddd}.navbar-default .navbar-toggle .icon-bar{background-color:#888}.navbar-default .navbar-collapse,.navbar-default .navbar-form{border-color:#e7e7e7}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.open>a:focus,.navbar-default .navbar-nav>.open>a:hover{color:#555;background-color:#e7e7e7}@media (max-width:767px){.navbar-default .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-default .navbar-nav .open .dropdown-menu>li>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>li>a:hover{color:#333;background-color:transparent}.navbar-default .navbar-nav .open .dropdown-menu>.active>a,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:hover{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:hover{color:#ccc;background-color:transparent}}.navbar-default .navbar-link{color:#777}.navbar-default .navbar-link:hover{color:#333}.navbar-default .btn-link{color:#777}.navbar-default .btn-link:focus,.navbar-default .btn-link:hover{color:#333}.navbar-default .btn-link[disabled]:focus,.navbar-default .btn-link[disabled]:hover,fieldset[disabled] .navbar-default .btn-link:focus,fieldset[disabled] .navbar-default .btn-link:hover{color:#ccc}.navbar-inverse{background-color:#222;border-color:#080808}.navbar-inverse .navbar-brand{color:#9d9d9d}.navbar-inverse .navbar-brand:focus,.navbar-inverse .navbar-brand:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-text{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a:focus,.navbar-inverse .navbar-nav>li>a:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav>.active>a,.navbar-inverse .navbar-nav>.active>a:focus,.navbar-inverse .navbar-nav>.active>a:hover{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.disabled>a,.navbar-inverse .navbar-nav>.disabled>a:focus,.navbar-inverse .navbar-nav>.disabled>a:hover{color:#444;background-color:transparent}.navbar-inverse .navbar-toggle{border-color:#333}.navbar-inverse .navbar-toggle:focus,.navbar-inverse .navbar-toggle:hover{background-color:#333}.navbar-inverse .navbar-toggle .icon-bar{background-color:#fff}.navbar-inverse .navbar-collapse,.navbar-inverse .navbar-form{border-color:#101010}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.open>a:focus,.navbar-inverse .navbar-nav>.open>a:hover{color:#fff;background-color:#080808}@media (max-width:767px){.navbar-inverse .navbar-nav .open .dropdown-menu>.dropdown-header{border-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu .divider{background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:hover{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:hover{color:#444;background-color:transparent}}.navbar-inverse .navbar-link{color:#9d9d9d}.navbar-inverse .navbar-link:hover{color:#fff}.navbar-inverse .btn-link{color:#9d9d9d}.navbar-inverse .btn-link:focus,.navbar-inverse .btn-link:hover{color:#fff}.navbar-inverse .btn-link[disabled]:focus,.navbar-inverse .btn-link[disabled]:hover,fieldset[disabled] .navbar-inverse .btn-link:focus,fieldset[disabled] .navbar-inverse .btn-link:hover{color:#444}.breadcrumb{padding:8px 15px;margin-bottom:20px;list-style:none;background-color:#f5f5f5;border-radius:4px}.breadcrumb>li{display:inline-block}.breadcrumb>li+li:before{padding:0 5px;color:#ccc;content:"/\00a0"}.breadcrumb>.active{color:#777}.pagination{display:inline-block;padding-left:0;margin:20px 0;border-radius:4px}.pagination>li{display:inline}.pagination>li>a,.pagination>li>span{position:relative;float:left;padding:6px 12px;margin-left:-1px;line-height:1.42857143;color:#337ab7;text-decoration:none;background-color:#fff;border:1px solid #ddd}.pagination>li:first-child>a,.pagination>li:first-child>span{margin-left:0;border-top-left-radius:4px;border-bottom-left-radius:4px}.pagination>li:last-child>a,.pagination>li:last-child>span{border-top-right-radius:4px;border-bottom-right-radius:4px}.pagination>li>a:focus,.pagination>li>a:hover,.pagination>li>span:focus,.pagination>li>span:hover{z-index:2;color:#23527c;background-color:#eee;border-color:#ddd}.pagination>.active>a,.pagination>.active>a:focus,.pagination>.active>a:hover,.pagination>.active>span,.pagination>.active>span:focus,.pagination>.active>span:hover{z-index:3;color:#fff;cursor:default;background-color:#337ab7;border-color:#337ab7}.pagination>.disabled>a,.pagination>.disabled>a:focus,.pagination>.disabled>a:hover,.pagination>.disabled>span,.pagination>.disabled>span:focus,.pagination>.disabled>span:hover{color:#777;cursor:not-allowed;background-color:#fff;border-color:#ddd}.pagination-lg>li>a,.pagination-lg>li>span{padding:10px 16px;font-size:18px;line-height:1.3333333}.pagination-lg>li:first-child>a,.pagination-lg>li:first-child>span{border-top-left-radius:6px;border-bottom-left-radius:6px}.pagination-lg>li:last-child>a,.pagination-lg>li:last-child>span{border-top-right-radius:6px;border-bottom-right-radius:6px}.pagination-sm>li>a,.pagination-sm>li>span{padding:5px 10px;font-size:12px;line-height:1.5}.pagination-sm>li:first-child>a,.pagination-sm>li:first-child>span{border-top-left-radius:3px;border-bottom-left-radius:3px}.pagination-sm>li:last-child>a,.pagination-sm>li:last-child>span{border-top-right-radius:3px;border-bottom-right-radius:3px}.pager{padding-left:0;margin:20px 0;text-align:center;list-style:none}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;border-radius:15px}.pager li>a:focus,.pager li>a:hover{text-decoration:none;background-color:#eee}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:focus,.pager .disabled>a:hover,.pager .disabled>span{color:#777;cursor:not-allowed;background-color:#fff}.label{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em}a.label:focus,a.label:hover{color:#fff;text-decoration:none;cursor:pointer}.label:empty{display:none}.btn .label{position:relative;top:-1px}.label-default{background-color:#777}.label-default[href]:focus,.label-default[href]:hover{background-color:#5e5e5e}.label-primary{background-color:#337ab7}.label-primary[href]:focus,.label-primary[href]:hover{background-color:#286090}.label-success{background-color:#5cb85c}.label-success[href]:focus,.label-success[href]:hover{background-color:#449d44}.label-info{background-color:#5bc0de}.label-info[href]:focus,.label-info[href]:hover{background-color:#31b0d5}.label-warning{background-color:#f0ad4e}.label-warning[href]:focus,.label-warning[href]:hover{background-color:#ec971f}.label-danger{background-color:#d9534f}.label-danger[href]:focus,.label-danger[href]:hover{background-color:#c9302c}.badge{display:inline-block;min-width:10px;padding:3px 7px;font-size:12px;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:middle;background-color:#777;border-radius:10px}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.btn-group-xs>.btn .badge,.btn-xs .badge{top:0;padding:1px 5px}a.badge:focus,a.badge:hover{color:#fff;text-decoration:none;cursor:pointer}.list-group-item.active>.badge,.nav-pills>.active>a>.badge{color:#337ab7;background-color:#fff}.list-group-item>.badge{float:right}.list-group-item>.badge+.badge{margin-right:5px}.nav-pills>li>a>.badge{margin-left:3px}.jumbotron{padding-top:30px;padding-bottom:30px;margin-bottom:30px;color:inherit;background-color:#eee}.jumbotron .h1,.jumbotron h1{color:inherit}.jumbotron p{margin-bottom:15px;font-size:21px;font-weight:200}.jumbotron>hr{border-top-color:#d5d5d5}.container .jumbotron,.container-fluid .jumbotron{padding-right:15px;padding-left:15px;border-radius:6px}.jumbotron .container{max-width:100%}@media screen and (min-width:768px){.jumbotron{padding-top:48px;padding-bottom:48px}.container .jumbotron,.container-fluid .jumbotron{padding-right:60px;padding-left:60px}.jumbotron .h1,.jumbotron h1{font-size:63px}}.thumbnail{display:block;padding:4px;margin-bottom:20px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:border .2s ease-in-out;-o-transition:border .2s ease-in-out;transition:border .2s ease-in-out}.thumbnail a>img,.thumbnail>img{margin-right:auto;margin-left:auto}a.thumbnail.active,a.thumbnail:focus,a.thumbnail:hover{border-color:#337ab7}.thumbnail .caption{padding:9px;color:#333}.alert{padding:15px;margin-bottom:20px;border:1px solid transparent;border-radius:4px}.alert h4{margin-top:0;color:inherit}.alert .alert-link{font-weight:700}.alert>p,.alert>ul{margin-bottom:0}.alert>p+p{margin-top:5px}.alert-dismissable,.alert-dismissible{padding-right:35px}.alert-dismissable .close,.alert-dismissible .close{position:relative;top:-2px;right:-21px;color:inherit}.alert-success{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.alert-success hr{border-top-color:#c9e2b3}.alert-success .alert-link{color:#2b542c}.alert-info{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.alert-info hr{border-top-color:#a6e1ec}.alert-info .alert-link{color:#245269}.alert-warning{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.alert-warning hr{border-top-color:#f7e1b5}.alert-warning .alert-link{color:#66512c}.alert-danger{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.alert-danger hr{border-top-color:#e4b9c0}.alert-danger .alert-link{color:#843534}@-webkit-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}.progress{height:20px;margin-bottom:20px;overflow:hidden;background-color:#f5f5f5;border-radius:4px;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,.1);box-shadow:inset 0 1px 2px rgba(0,0,0,.1)}.progress-bar{float:left;width:0;height:100%;font-size:12px;line-height:20px;color:#fff;text-align:center;background-color:#337ab7;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.15);box-shadow:inset 0 -1px 0 rgba(0,0,0,.15);-webkit-transition:width .6s ease;-o-transition:width .6s ease;transition:width .6s ease}.progress-bar-striped,.progress-striped .progress-bar{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);-webkit-background-size:40px 40px;background-size:40px 40px}.progress-bar.active,.progress.active .progress-bar{-webkit-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-bar-success{background-color:#5cb85c}.progress-striped .progress-bar-success{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-info{background-color:#5bc0de}.progress-striped .progress-bar-info{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-warning{background-color:#f0ad4e}.progress-striped .progress-bar-warning{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-danger{background-color:#d9534f}.progress-striped .progress-bar-danger{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.media{margin-top:15px}.media:first-child{margin-top:0}.media,.media-body{overflow:hidden;zoom:1}.media-body{width:10000px}.media-object{display:block}.media-object.img-thumbnail{max-width:none}.media-right,.media>.pull-right{padding-left:10px}.media-left,.media>.pull-left{padding-right:10px}.media-body,.media-left,.media-right{display:table-cell;vertical-align:top}.media-middle{vertical-align:middle}.media-bottom{vertical-align:bottom}.media-heading{margin-top:0;margin-bottom:5px}.media-list{padding-left:0;list-style:none}.list-group{padding-left:0;margin-bottom:20px}.list-group-item{position:relative;display:block;padding:10px 15px;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-left-radius:4px;border-top-right-radius:4px}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}a.list-group-item,button.list-group-item{color:#555}a.list-group-item .list-group-item-heading,button.list-group-item .list-group-item-heading{color:#333}a.list-group-item:focus,a.list-group-item:hover,button.list-group-item:focus,button.list-group-item:hover{color:#555;text-decoration:none;background-color:#f5f5f5}button.list-group-item{width:100%;text-align:left}.list-group-item.disabled,.list-group-item.disabled:focus,.list-group-item.disabled:hover{color:#777;cursor:not-allowed;background-color:#eee}.list-group-item.disabled .list-group-item-heading,.list-group-item.disabled:focus .list-group-item-heading,.list-group-item.disabled:hover .list-group-item-heading{color:inherit}.list-group-item.disabled .list-group-item-text,.list-group-item.disabled:focus .list-group-item-text,.list-group-item.disabled:hover .list-group-item-text{color:#777}.list-group-item.active,.list-group-item.active:focus,.list-group-item.active:hover{z-index:2;color:#fff;background-color:#337ab7;border-color:#337ab7}.list-group-item.active .list-group-item-heading,.list-group-item.active .list-group-item-heading>.small,.list-group-item.active .list-group-item-heading>small,.list-group-item.active:focus .list-group-item-heading,.list-group-item.active:focus .list-group-item-heading>.small,.list-group-item.active:focus .list-group-item-heading>small,.list-group-item.active:hover .list-group-item-heading,.list-group-item.active:hover .list-group-item-heading>.small,.list-group-item.active:hover .list-group-item-heading>small{color:inherit}.list-group-item.active .list-group-item-text,.list-group-item.active:focus .list-group-item-text,.list-group-item.active:hover .list-group-item-text{color:#c7ddef}.list-group-item-success{color:#3c763d;background-color:#dff0d8}a.list-group-item-success,button.list-group-item-success{color:#3c763d}a.list-group-item-success .list-group-item-heading,button.list-group-item-success .list-group-item-heading{color:inherit}a.list-group-item-success:focus,a.list-group-item-success:hover,button.list-group-item-success:focus,button.list-group-item-success:hover{color:#3c763d;background-color:#d0e9c6}a.list-group-item-success.active,a.list-group-item-success.active:focus,a.list-group-item-success.active:hover,button.list-group-item-success.active,button.list-group-item-success.active:focus,button.list-group-item-success.active:hover{color:#fff;background-color:#3c763d;border-color:#3c763d}.list-group-item-info{color:#31708f;background-color:#d9edf7}a.list-group-item-info,button.list-group-item-info{color:#31708f}a.list-group-item-info .list-group-item-heading,button.list-group-item-info .list-group-item-heading{color:inherit}a.list-group-item-info:focus,a.list-group-item-info:hover,button.list-group-item-info:focus,button.list-group-item-info:hover{color:#31708f;background-color:#c4e3f3}a.list-group-item-info.active,a.list-group-item-info.active:focus,a.list-group-item-info.active:hover,button.list-group-item-info.active,button.list-group-item-info.active:focus,button.list-group-item-info.active:hover{color:#fff;background-color:#31708f;border-color:#31708f}.list-group-item-warning{color:#8a6d3b;background-color:#fcf8e3}a.list-group-item-warning,button.list-group-item-warning{color:#8a6d3b}a.list-group-item-warning .list-group-item-heading,button.list-group-item-warning .list-group-item-heading{color:inherit}a.list-group-item-warning:focus,a.list-group-item-warning:hover,button.list-group-item-warning:focus,button.list-group-item-warning:hover{color:#8a6d3b;background-color:#faf2cc}a.list-group-item-warning.active,a.list-group-item-warning.active:focus,a.list-group-item-warning.active:hover,button.list-group-item-warning.active,button.list-group-item-warning.active:focus,button.list-group-item-warning.active:hover{color:#fff;background-color:#8a6d3b;border-color:#8a6d3b}.list-group-item-danger{color:#a94442;background-color:#f2dede}a.list-group-item-danger,button.list-group-item-danger{color:#a94442}a.list-group-item-danger .list-group-item-heading,button.list-group-item-danger .list-group-item-heading{color:inherit}a.list-group-item-danger:focus,a.list-group-item-danger:hover,button.list-group-item-danger:focus,button.list-group-item-danger:hover{color:#a94442;background-color:#ebcccc}a.list-group-item-danger.active,a.list-group-item-danger.active:focus,a.list-group-item-danger.active:hover,button.list-group-item-danger.active,button.list-group-item-danger.active:focus,button.list-group-item-danger.active:hover{color:#fff;background-color:#a94442;border-color:#a94442}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;-webkit-box-shadow:0 1px 1px rgba(0,0,0,.05);box-shadow:0 1px 1px rgba(0,0,0,.05)}.panel-body{padding:15px}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px}.panel-heading>.dropdown .dropdown-toggle{color:inherit}.panel-title{margin-top:0;margin-bottom:0;font-size:16px;color:inherit}.panel-title>.small,.panel-title>.small>a,.panel-title>a,.panel-title>small,.panel-title>small>a{color:inherit}.panel-footer{padding:10px 15px;background-color:#f5f5f5;border-top:1px solid #ddd;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.list-group,.panel>.panel-collapse>.list-group{margin-bottom:0}.panel>.list-group .list-group-item,.panel>.panel-collapse>.list-group .list-group-item{border-width:1px 0;border-radius:0}.panel>.list-group:first-child .list-group-item:first-child,.panel>.panel-collapse>.list-group:first-child .list-group-item:first-child{border-top:0;border-top-left-radius:3px;border-top-right-radius:3px}.panel>.list-group:last-child .list-group-item:last-child,.panel>.panel-collapse>.list-group:last-child .list-group-item:last-child{border-bottom:0;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.panel-heading+.panel-collapse>.list-group .list-group-item:first-child{border-top-left-radius:0;border-top-right-radius:0}.panel-heading+.list-group .list-group-item:first-child{border-top-width:0}.list-group+.panel-footer{border-top-width:0}.panel>.panel-collapse>.table,.panel>.table,.panel>.table-responsive>.table{margin-bottom:0}.panel>.panel-collapse>.table caption,.panel>.table caption,.panel>.table-responsive>.table caption{padding-right:15px;padding-left:15px}.panel>.table-responsive:first-child>.table:first-child,.panel>.table:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child,.panel>.table:first-child>thead:first-child>tr:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table:first-child>thead:first-child>tr:first-child th:first-child{border-top-left-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table:first-child>thead:first-child>tr:first-child th:last-child{border-top-right-radius:3px}.panel>.table-responsive:last-child>.table:last-child,.panel>.table:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:first-child{border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:last-child{border-bottom-right-radius:3px}.panel>.panel-body+.table,.panel>.panel-body+.table-responsive,.panel>.table+.panel-body,.panel>.table-responsive+.panel-body{border-top:1px solid #ddd}.panel>.table>tbody:first-child>tr:first-child td,.panel>.table>tbody:first-child>tr:first-child th{border-top:0}.panel>.table-bordered,.panel>.table-responsive>.table-bordered{border:0}.panel>.table-bordered>tbody>tr>td:first-child,.panel>.table-bordered>tbody>tr>th:first-child,.panel>.table-bordered>tfoot>tr>td:first-child,.panel>.table-bordered>tfoot>tr>th:first-child,.panel>.table-bordered>thead>tr>td:first-child,.panel>.table-bordered>thead>tr>th:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:first-child,.panel>.table-responsive>.table-bordered>thead>tr>td:first-child,.panel>.table-responsive>.table-bordered>thead>tr>th:first-child{border-left:0}.panel>.table-bordered>tbody>tr>td:last-child,.panel>.table-bordered>tbody>tr>th:last-child,.panel>.table-bordered>tfoot>tr>td:last-child,.panel>.table-bordered>tfoot>tr>th:last-child,.panel>.table-bordered>thead>tr>td:last-child,.panel>.table-bordered>thead>tr>th:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:last-child,.panel>.table-responsive>.table-bordered>thead>tr>td:last-child,.panel>.table-responsive>.table-bordered>thead>tr>th:last-child{border-right:0}.panel>.table-bordered>tbody>tr:first-child>td,.panel>.table-bordered>tbody>tr:first-child>th,.panel>.table-bordered>thead>tr:first-child>td,.panel>.table-bordered>thead>tr:first-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>th,.panel>.table-responsive>.table-bordered>thead>tr:first-child>td,.panel>.table-responsive>.table-bordered>thead>tr:first-child>th{border-bottom:0}.panel>.table-bordered>tbody>tr:last-child>td,.panel>.table-bordered>tbody>tr:last-child>th,.panel>.table-bordered>tfoot>tr:last-child>td,.panel>.table-bordered>tfoot>tr:last-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>th,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>td,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}.panel>.table-responsive{margin-bottom:0;border:0}.panel-group{margin-bottom:20px}.panel-group .panel{margin-bottom:0;border-radius:4px}.panel-group .panel+.panel{margin-top:5px}.panel-group .panel-heading{border-bottom:0}.panel-group .panel-heading+.panel-collapse>.list-group,.panel-group .panel-heading+.panel-collapse>.panel-body{border-top:1px solid #ddd}.panel-group .panel-footer{border-top:0}.panel-group .panel-footer+.panel-collapse .panel-body{border-bottom:1px solid #ddd}.panel-default{border-color:#ddd}.panel-default>.panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd}.panel-default>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ddd}.panel-default>.panel-heading .badge{color:#f5f5f5;background-color:#333}.panel-default>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ddd}.panel-primary{border-color:#337ab7}.panel-primary>.panel-heading{color:#fff;background-color:#337ab7;border-color:#337ab7}.panel-primary>.panel-heading+.panel-collapse>.panel-body{border-top-color:#337ab7}.panel-primary>.panel-heading .badge{color:#337ab7;background-color:#fff}.panel-primary>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#337ab7}.panel-success{border-color:#d6e9c6}.panel-success>.panel-heading{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.panel-success>.panel-heading+.panel-collapse>.panel-body{border-top-color:#d6e9c6}.panel-success>.panel-heading .badge{color:#dff0d8;background-color:#3c763d}.panel-success>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#d6e9c6}.panel-info{border-color:#bce8f1}.panel-info>.panel-heading{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.panel-info>.panel-heading+.panel-collapse>.panel-body{border-top-color:#bce8f1}.panel-info>.panel-heading .badge{color:#d9edf7;background-color:#31708f}.panel-info>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#bce8f1}.panel-warning{border-color:#faebcc}.panel-warning>.panel-heading{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.panel-warning>.panel-heading+.panel-collapse>.panel-body{border-top-color:#faebcc}.panel-warning>.panel-heading .badge{color:#fcf8e3;background-color:#8a6d3b}.panel-warning>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#faebcc}.panel-danger{border-color:#ebccd1}.panel-danger>.panel-heading{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.panel-danger>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ebccd1}.panel-danger>.panel-heading .badge{color:#f2dede;background-color:#a94442}.panel-danger>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ebccd1}.embed-responsive{position:relative;display:block;height:0;padding:0;overflow:hidden}.embed-responsive .embed-responsive-item,.embed-responsive embed,.embed-responsive iframe,.embed-responsive object,.embed-responsive video{position:absolute;top:0;bottom:0;left:0;width:100%;height:100%;border:0}.embed-responsive-16by9{padding-bottom:56.25%}.embed-responsive-4by3{padding-bottom:75%}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.05);box-shadow:inset 0 1px 1px rgba(0,0,0,.05)}.well blockquote{border-color:#ddd;border-color:rgba(0,0,0,.15)}.well-lg{padding:24px;border-radius:6px}.well-sm{padding:9px;border-radius:3px}.close{float:right;font-size:21px;font-weight:700;line-height:1;color:#000;text-shadow:0 1px 0 #fff;filter:alpha(opacity=20);opacity:.2}.close:focus,.close:hover{color:#000;text-decoration:none;cursor:pointer;filter:alpha(opacity=50);opacity:.5}button.close{-webkit-appearance:none;padding:0;cursor:pointer;background:0 0;border:0}.modal-open{overflow:hidden}.modal{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1050;display:none;overflow:hidden;-webkit-overflow-scrolling:touch;outline:0}.modal.fade .modal-dialog{-webkit-transition:-webkit-transform .3s ease-out;-o-transition:-o-transform .3s ease-out;transition:transform .3s ease-out;-webkit-transform:translate(0,-25%);-ms-transform:translate(0,-25%);-o-transform:translate(0,-25%);transform:translate(0,-25%)}.modal.in .modal-dialog{-webkit-transform:translate(0,0);-ms-transform:translate(0,0);-o-transform:translate(0,0);transform:translate(0,0)}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal-dialog{position:relative;width:auto;margin:10px}.modal-content{position:relative;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #999;border:1px solid rgba(0,0,0,.2);border-radius:6px;outline:0;-webkit-box-shadow:0 3px 9px rgba(0,0,0,.5);box-shadow:0 3px 9px rgba(0,0,0,.5)}.modal-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;background-color:#000}.modal-backdrop.fade{filter:alpha(opacity=0);opacity:0}.modal-backdrop.in{filter:alpha(opacity=50);opacity:.5}.modal-header{padding:15px;border-bottom:1px solid #e5e5e5}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.42857143}.modal-body{position:relative;padding:15px}.modal-footer{padding:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer .btn+.btn{margin-bottom:0;margin-left:5px}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:768px){.modal-dialog{width:600px;margin:30px auto}.modal-content{-webkit-box-shadow:0 5px 15px rgba(0,0,0,.5);box-shadow:0 5px 15px rgba(0,0,0,.5)}.modal-sm{width:300px}}@media (min-width:992px){.modal-lg{width:900px}}.tooltip{position:absolute;z-index:1070;display:block;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:12px;font-style:normal;font-weight:400;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;filter:alpha(opacity=0);opacity:0;line-break:auto}.tooltip.in{filter:alpha(opacity=90);opacity:.9}.tooltip.top{padding:5px 0;margin-top:-3px}.tooltip.right{padding:0 5px;margin-left:3px}.tooltip.bottom{padding:5px 0;margin-top:3px}.tooltip.left{padding:0 5px;margin-left:-3px}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;background-color:#000;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-left .tooltip-arrow{right:5px;bottom:0;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-right .tooltip-arrow{bottom:0;left:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-width:5px 5px 5px 0;border-right-color:#000}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-width:5px 0 5px 5px;border-left-color:#000}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-left .tooltip-arrow{top:0;right:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-right .tooltip-arrow{top:0;left:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.popover{position:absolute;top:0;left:0;z-index:1060;display:none;max-width:276px;padding:1px;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.2);border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,.2);box-shadow:0 5px 10px rgba(0,0,0,.2);line-break:auto}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover-title{padding:8px 14px;margin:0;font-size:14px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.popover>.arrow,.popover>.arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover>.arrow{border-width:11px}.popover>.arrow:after{content:"";border-width:10px}.popover.top>.arrow{bottom:-11px;left:50%;margin-left:-11px;border-top-color:#999;border-top-color:rgba(0,0,0,.25);border-bottom-width:0}.popover.top>.arrow:after{bottom:1px;margin-left:-10px;content:" ";border-top-color:#fff;border-bottom-width:0}.popover.right>.arrow{top:50%;left:-11px;margin-top:-11px;border-right-color:#999;border-right-color:rgba(0,0,0,.25);border-left-width:0}.popover.right>.arrow:after{bottom:-10px;left:1px;content:" ";border-right-color:#fff;border-left-width:0}.popover.bottom>.arrow{top:-11px;left:50%;margin-left:-11px;border-top-width:0;border-bottom-color:#999;border-bottom-color:rgba(0,0,0,.25)}.popover.bottom>.arrow:after{top:1px;margin-left:-10px;content:" ";border-top-width:0;border-bottom-color:#fff}.popover.left>.arrow{top:50%;right:-11px;margin-top:-11px;border-right-width:0;border-left-color:#999;border-left-color:rgba(0,0,0,.25)}.popover.left>.arrow:after{right:1px;bottom:-10px;content:" ";border-right-width:0;border-left-color:#fff}.carousel{position:relative}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner>.item{position:relative;display:none;-webkit-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>a>img,.carousel-inner>.item>img{line-height:1}@media all and (transform-3d),(-webkit-transform-3d){.carousel-inner>.item{-webkit-transition:-webkit-transform .6s ease-in-out;-o-transition:-o-transform .6s ease-in-out;transition:transform .6s ease-in-out;-webkit-backface-visibility:hidden;backface-visibility:hidden;-webkit-perspective:1000px;perspective:1000px}.carousel-inner>.item.active.right,.carousel-inner>.item.next{left:0;-webkit-transform:translate3d(100%,0,0);transform:translate3d(100%,0,0)}.carousel-inner>.item.active.left,.carousel-inner>.item.prev{left:0;-webkit-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0)}.carousel-inner>.item.active,.carousel-inner>.item.next.left,.carousel-inner>.item.prev.right{left:0;-webkit-transform:translate3d(0,0,0);transform:translate3d(0,0,0)}}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;bottom:0;left:0;width:15%;font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6);background-color:rgba(0,0,0,0);filter:alpha(opacity=50);opacity:.5}.carousel-control.left{background-image:-webkit-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.5)),to(rgba(0,0,0,.0001)));background-image:linear-gradient(to right,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1);background-repeat:repeat-x}.carousel-control.right{right:0;left:auto;background-image:-webkit-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.0001)),to(rgba(0,0,0,.5)));background-image:linear-gradient(to right,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1);background-repeat:repeat-x}.carousel-control:focus,.carousel-control:hover{color:#fff;text-decoration:none;filter:alpha(opacity=90);outline:0;opacity:.9}.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next,.carousel-control .icon-prev{position:absolute;top:50%;z-index:5;display:inline-block;margin-top:-10px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{left:50%;margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{right:50%;margin-right:-10px}.carousel-control .icon-next,.carousel-control .icon-prev{width:20px;height:20px;font-family:serif;line-height:1}.carousel-control .icon-prev:before{content:'\2039'}.carousel-control .icon-next:before{content:'\203a'}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;padding-left:0;margin-left:-30%;text-align:center;list-style:none}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;cursor:pointer;background-color:#000\9;background-color:rgba(0,0,0,0);border:1px solid #fff;border-radius:10px}.carousel-indicators .active{width:12px;height:12px;margin:0;background-color:#fff}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6)}.carousel-caption .btn{text-shadow:none}@media screen and (min-width:768px){.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next,.carousel-control .icon-prev{width:30px;height:30px;margin-top:-10px;font-size:30px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{margin-right:-10px}.carousel-caption{right:20%;left:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.btn-group-vertical>.btn-group:after,.btn-group-vertical>.btn-group:before,.btn-toolbar:after,.btn-toolbar:before,.clearfix:after,.clearfix:before,.container-fluid:after,.container-fluid:before,.container:after,.container:before,.dl-horizontal dd:after,.dl-horizontal dd:before,.form-horizontal .form-group:after,.form-horizontal .form-group:before,.modal-footer:after,.modal-footer:before,.modal-header:after,.modal-header:before,.nav:after,.nav:before,.navbar-collapse:after,.navbar-collapse:before,.navbar-header:after,.navbar-header:before,.navbar:after,.navbar:before,.pager:after,.pager:before,.panel-body:after,.panel-body:before,.row:after,.row:before{display:table;content:" "}.btn-group-vertical>.btn-group:after,.btn-toolbar:after,.clearfix:after,.container-fluid:after,.container:after,.dl-horizontal dd:after,.form-horizontal .form-group:after,.modal-footer:after,.modal-header:after,.nav:after,.navbar-collapse:after,.navbar-header:after,.navbar:after,.pager:after,.panel-body:after,.row:after{clear:both}.center-block{display:block;margin-right:auto;margin-left:auto}.pull-right{float:right!important}.pull-left{float:left!important}.hide{display:none!important}.show{display:block!important}.invisible{visibility:hidden}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.hidden{display:none!important}.affix{position:fixed}@-ms-viewport{width:device-width}.visible-lg,.visible-md,.visible-sm,.visible-xs{display:none!important}.visible-lg-block,.visible-lg-inline,.visible-lg-inline-block,.visible-md-block,.visible-md-inline,.visible-md-inline-block,.visible-sm-block,.visible-sm-inline,.visible-sm-inline-block,.visible-xs-block,.visible-xs-inline,.visible-xs-inline-block{display:none!important}@media (max-width:767px){.visible-xs{display:block!important}table.visible-xs{display:table!important}tr.visible-xs{display:table-row!important}td.visible-xs,th.visible-xs{display:table-cell!important}}@media (max-width:767px){.visible-xs-block{display:block!important}}@media (max-width:767px){.visible-xs-inline{display:inline!important}}@media (max-width:767px){.visible-xs-inline-block{display:inline-block!important}}@media (min-width:768px) and (max-width:991px){.visible-sm{display:block!important}table.visible-sm{display:table!important}tr.visible-sm{display:table-row!important}td.visible-sm,th.visible-sm{display:table-cell!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-block{display:block!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline{display:inline!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline-block{display:inline-block!important}}@media (min-width:992px) and (max-width:1199px){.visible-md{display:block!important}table.visible-md{display:table!important}tr.visible-md{display:table-row!important}td.visible-md,th.visible-md{display:table-cell!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-block{display:block!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline{display:inline!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline-block{display:inline-block!important}}@media (min-width:1200px){.visible-lg{display:block!important}table.visible-lg{display:table!important}tr.visible-lg{display:table-row!important}td.visible-lg,th.visible-lg{display:table-cell!important}}@media (min-width:1200px){.visible-lg-block{display:block!important}}@media (min-width:1200px){.visible-lg-inline{display:inline!important}}@media (min-width:1200px){.visible-lg-inline-block{display:inline-block!important}}@media (max-width:767px){.hidden-xs{display:none!important}}@media (min-width:768px) and (max-width:991px){.hidden-sm{display:none!important}}@media (min-width:992px) and (max-width:1199px){.hidden-md{display:none!important}}@media (min-width:1200px){.hidden-lg{display:none!important}}.visible-print{display:none!important}@media print{.visible-print{display:block!important}table.visible-print{display:table!important}tr.visible-print{display:table-row!important}td.visible-print,th.visible-print{display:table-cell!important}}.visible-print-block{display:none!important}@media print{.visible-print-block{display:block!important}}.visible-print-inline{display:none!important}@media print{.visible-print-inline{display:inline!important}}.visible-print-inline-block{display:none!important}@media print{.visible-print-inline-block{display:inline-block!important}}@media print{.hidden-print{display:none!important}} +/*# sourceMappingURL=bootstrap.min.css.map */ \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css new file mode 100755 index 0000000000000..ee906a8196d0f --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css @@ -0,0 +1,2337 @@ +/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */ +/* FONT PATH + * -------------------------- */ +@font-face { + font-family: 'FontAwesome'; + src: url('../fonts/fontawesome-webfont.eot?v=4.7.0'); + src: url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'), url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'), url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'), url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg'); + font-weight: normal; + font-style: normal; +} +.fa { + display: inline-block; + font: normal normal normal 14px/1 FontAwesome; + font-size: inherit; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} +/* makes the font 33% larger relative to the icon container */ +.fa-lg { + font-size: 1.33333333em; + line-height: 0.75em; + vertical-align: -15%; +} +.fa-2x { + font-size: 2em; +} +.fa-3x { + font-size: 3em; +} +.fa-4x { + font-size: 4em; +} +.fa-5x { + font-size: 5em; +} +.fa-fw { + width: 1.28571429em; + text-align: center; +} +.fa-ul { + padding-left: 0; + margin-left: 2.14285714em; + list-style-type: none; +} +.fa-ul > li { + position: relative; +} +.fa-li { + position: absolute; + left: -2.14285714em; + width: 2.14285714em; + top: 0.14285714em; + text-align: center; +} +.fa-li.fa-lg { + left: -1.85714286em; +} +.fa-border { + padding: .2em .25em .15em; + border: solid 0.08em #eeeeee; + border-radius: .1em; +} +.fa-pull-left { + float: left; +} +.fa-pull-right { + float: right; +} +.fa.fa-pull-left { + margin-right: .3em; +} +.fa.fa-pull-right { + margin-left: .3em; +} +/* Deprecated as of 4.4.0 */ +.pull-right { + float: right; +} +.pull-left { + float: left; +} +.fa.pull-left { + margin-right: .3em; +} +.fa.pull-right { + margin-left: .3em; +} +.fa-spin { + -webkit-animation: fa-spin 2s infinite linear; + animation: fa-spin 2s infinite linear; +} +.fa-pulse { + -webkit-animation: fa-spin 1s infinite steps(8); + animation: fa-spin 1s infinite steps(8); +} +@-webkit-keyframes fa-spin { + 0% { + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +@keyframes fa-spin { + 0% { + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +.fa-rotate-90 { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=1)"; + -webkit-transform: rotate(90deg); + -ms-transform: rotate(90deg); + transform: rotate(90deg); +} +.fa-rotate-180 { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2)"; + -webkit-transform: rotate(180deg); + -ms-transform: rotate(180deg); + transform: rotate(180deg); +} +.fa-rotate-270 { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=3)"; + -webkit-transform: rotate(270deg); + -ms-transform: rotate(270deg); + transform: rotate(270deg); +} +.fa-flip-horizontal { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)"; + -webkit-transform: scale(-1, 1); + -ms-transform: scale(-1, 1); + transform: scale(-1, 1); +} +.fa-flip-vertical { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)"; + -webkit-transform: scale(1, -1); + -ms-transform: scale(1, -1); + transform: scale(1, -1); +} +:root .fa-rotate-90, +:root .fa-rotate-180, +:root .fa-rotate-270, +:root .fa-flip-horizontal, +:root .fa-flip-vertical { + filter: none; +} +.fa-stack { + position: relative; + display: inline-block; + width: 2em; + height: 2em; + line-height: 2em; + vertical-align: middle; +} +.fa-stack-1x, +.fa-stack-2x { + position: absolute; + left: 0; + width: 100%; + text-align: center; +} +.fa-stack-1x { + line-height: inherit; +} +.fa-stack-2x { + font-size: 2em; +} +.fa-inverse { + color: #ffffff; +} +/* Font Awesome uses the Unicode Private Use Area (PUA) to ensure screen + readers do not read off random characters that represent icons */ +.fa-glass:before { + content: "\f000"; +} +.fa-music:before { + content: "\f001"; +} +.fa-search:before { + content: "\f002"; +} +.fa-envelope-o:before { + content: "\f003"; +} +.fa-heart:before { + content: "\f004"; +} +.fa-star:before { + content: "\f005"; +} +.fa-star-o:before { + content: "\f006"; +} +.fa-user:before { + content: "\f007"; +} +.fa-film:before { + content: "\f008"; +} +.fa-th-large:before { + content: "\f009"; +} +.fa-th:before { + content: "\f00a"; +} +.fa-th-list:before { + content: "\f00b"; +} +.fa-check:before { + content: "\f00c"; +} +.fa-remove:before, +.fa-close:before, +.fa-times:before { + content: "\f00d"; +} +.fa-search-plus:before { + content: "\f00e"; +} +.fa-search-minus:before { + content: "\f010"; +} +.fa-power-off:before { + content: "\f011"; +} +.fa-signal:before { + content: "\f012"; +} +.fa-gear:before, +.fa-cog:before { + content: "\f013"; +} +.fa-trash-o:before { + content: "\f014"; +} +.fa-home:before { + content: "\f015"; +} +.fa-file-o:before { + content: "\f016"; +} +.fa-clock-o:before { + content: "\f017"; +} +.fa-road:before { + content: "\f018"; +} +.fa-download:before { + content: "\f019"; +} +.fa-arrow-circle-o-down:before { + content: "\f01a"; +} +.fa-arrow-circle-o-up:before { + content: "\f01b"; +} +.fa-inbox:before { + content: "\f01c"; +} +.fa-play-circle-o:before { + content: "\f01d"; +} +.fa-rotate-right:before, +.fa-repeat:before { + content: "\f01e"; +} +.fa-refresh:before { + content: "\f021"; +} +.fa-list-alt:before { + content: "\f022"; +} +.fa-lock:before { + content: "\f023"; +} +.fa-flag:before { + content: "\f024"; +} +.fa-headphones:before { + content: "\f025"; +} +.fa-volume-off:before { + content: "\f026"; +} +.fa-volume-down:before { + content: "\f027"; +} +.fa-volume-up:before { + content: "\f028"; +} +.fa-qrcode:before { + content: "\f029"; +} +.fa-barcode:before { + content: "\f02a"; +} +.fa-tag:before { + content: "\f02b"; +} +.fa-tags:before { + content: "\f02c"; +} +.fa-book:before { + content: "\f02d"; +} +.fa-bookmark:before { + content: "\f02e"; +} +.fa-print:before { + content: "\f02f"; +} +.fa-camera:before { + content: "\f030"; +} +.fa-font:before { + content: "\f031"; +} +.fa-bold:before { + content: "\f032"; +} +.fa-italic:before { + content: "\f033"; +} +.fa-text-height:before { + content: "\f034"; +} +.fa-text-width:before { + content: "\f035"; +} +.fa-align-left:before { + content: "\f036"; +} +.fa-align-center:before { + content: "\f037"; +} +.fa-align-right:before { + content: "\f038"; +} +.fa-align-justify:before { + content: "\f039"; +} +.fa-list:before { + content: "\f03a"; +} +.fa-dedent:before, +.fa-outdent:before { + content: "\f03b"; +} +.fa-indent:before { + content: "\f03c"; +} +.fa-video-camera:before { + content: "\f03d"; +} +.fa-photo:before, +.fa-image:before, +.fa-picture-o:before { + content: "\f03e"; +} +.fa-pencil:before { + content: "\f040"; +} +.fa-map-marker:before { + content: "\f041"; +} +.fa-adjust:before { + content: "\f042"; +} +.fa-tint:before { + content: "\f043"; +} +.fa-edit:before, +.fa-pencil-square-o:before { + content: "\f044"; +} +.fa-share-square-o:before { + content: "\f045"; +} +.fa-check-square-o:before { + content: "\f046"; +} +.fa-arrows:before { + content: "\f047"; +} +.fa-step-backward:before { + content: "\f048"; +} +.fa-fast-backward:before { + content: "\f049"; +} +.fa-backward:before { + content: "\f04a"; +} +.fa-play:before { + content: "\f04b"; +} +.fa-pause:before { + content: "\f04c"; +} +.fa-stop:before { + content: "\f04d"; +} +.fa-forward:before { + content: "\f04e"; +} +.fa-fast-forward:before { + content: "\f050"; +} +.fa-step-forward:before { + content: "\f051"; +} +.fa-eject:before { + content: "\f052"; +} +.fa-chevron-left:before { + content: "\f053"; +} +.fa-chevron-right:before { + content: "\f054"; +} +.fa-plus-circle:before { + content: "\f055"; +} +.fa-minus-circle:before { + content: "\f056"; +} +.fa-times-circle:before { + content: "\f057"; +} +.fa-check-circle:before { + content: "\f058"; +} +.fa-question-circle:before { + content: "\f059"; +} +.fa-info-circle:before { + content: "\f05a"; +} +.fa-crosshairs:before { + content: "\f05b"; +} +.fa-times-circle-o:before { + content: "\f05c"; +} +.fa-check-circle-o:before { + content: "\f05d"; +} +.fa-ban:before { + content: "\f05e"; +} +.fa-arrow-left:before { + content: "\f060"; +} +.fa-arrow-right:before { + content: "\f061"; +} +.fa-arrow-up:before { + content: "\f062"; +} +.fa-arrow-down:before { + content: "\f063"; +} +.fa-mail-forward:before, +.fa-share:before { + content: "\f064"; +} +.fa-expand:before { + content: "\f065"; +} +.fa-compress:before { + content: "\f066"; +} +.fa-plus:before { + content: "\f067"; +} +.fa-minus:before { + content: "\f068"; +} +.fa-asterisk:before { + content: "\f069"; +} +.fa-exclamation-circle:before { + content: "\f06a"; +} +.fa-gift:before { + content: "\f06b"; +} +.fa-leaf:before { + content: "\f06c"; +} +.fa-fire:before { + content: "\f06d"; +} +.fa-eye:before { + content: "\f06e"; +} +.fa-eye-slash:before { + content: "\f070"; +} +.fa-warning:before, +.fa-exclamation-triangle:before { + content: "\f071"; +} +.fa-plane:before { + content: "\f072"; +} +.fa-calendar:before { + content: "\f073"; +} +.fa-random:before { + content: "\f074"; +} +.fa-comment:before { + content: "\f075"; +} +.fa-magnet:before { + content: "\f076"; +} +.fa-chevron-up:before { + content: "\f077"; +} +.fa-chevron-down:before { + content: "\f078"; +} +.fa-retweet:before { + content: "\f079"; +} +.fa-shopping-cart:before { + content: "\f07a"; +} +.fa-folder:before { + content: "\f07b"; +} +.fa-folder-open:before { + content: "\f07c"; +} +.fa-arrows-v:before { + content: "\f07d"; +} +.fa-arrows-h:before { + content: "\f07e"; +} +.fa-bar-chart-o:before, +.fa-bar-chart:before { + content: "\f080"; +} +.fa-twitter-square:before { + content: "\f081"; +} +.fa-facebook-square:before { + content: "\f082"; +} +.fa-camera-retro:before { + content: "\f083"; +} +.fa-key:before { + content: "\f084"; +} +.fa-gears:before, +.fa-cogs:before { + content: "\f085"; +} +.fa-comments:before { + content: "\f086"; +} +.fa-thumbs-o-up:before { + content: "\f087"; +} +.fa-thumbs-o-down:before { + content: "\f088"; +} +.fa-star-half:before { + content: "\f089"; +} +.fa-heart-o:before { + content: "\f08a"; +} +.fa-sign-out:before { + content: "\f08b"; +} +.fa-linkedin-square:before { + content: "\f08c"; +} +.fa-thumb-tack:before { + content: "\f08d"; +} +.fa-external-link:before { + content: "\f08e"; +} +.fa-sign-in:before { + content: "\f090"; +} +.fa-trophy:before { + content: "\f091"; +} +.fa-github-square:before { + content: "\f092"; +} +.fa-upload:before { + content: "\f093"; +} +.fa-lemon-o:before { + content: "\f094"; +} +.fa-phone:before { + content: "\f095"; +} +.fa-square-o:before { + content: "\f096"; +} +.fa-bookmark-o:before { + content: "\f097"; +} +.fa-phone-square:before { + content: "\f098"; +} +.fa-twitter:before { + content: "\f099"; +} +.fa-facebook-f:before, +.fa-facebook:before { + content: "\f09a"; +} +.fa-github:before { + content: "\f09b"; +} +.fa-unlock:before { + content: "\f09c"; +} +.fa-credit-card:before { + content: "\f09d"; +} +.fa-feed:before, +.fa-rss:before { + content: "\f09e"; +} +.fa-hdd-o:before { + content: "\f0a0"; +} +.fa-bullhorn:before { + content: "\f0a1"; +} +.fa-bell:before { + content: "\f0f3"; +} +.fa-certificate:before { + content: "\f0a3"; +} +.fa-hand-o-right:before { + content: "\f0a4"; +} +.fa-hand-o-left:before { + content: "\f0a5"; +} +.fa-hand-o-up:before { + content: "\f0a6"; +} +.fa-hand-o-down:before { + content: "\f0a7"; +} +.fa-arrow-circle-left:before { + content: "\f0a8"; +} +.fa-arrow-circle-right:before { + content: "\f0a9"; +} +.fa-arrow-circle-up:before { + content: "\f0aa"; +} +.fa-arrow-circle-down:before { + content: "\f0ab"; +} +.fa-globe:before { + content: "\f0ac"; +} +.fa-wrench:before { + content: "\f0ad"; +} +.fa-tasks:before { + content: "\f0ae"; +} +.fa-filter:before { + content: "\f0b0"; +} +.fa-briefcase:before { + content: "\f0b1"; +} +.fa-arrows-alt:before { + content: "\f0b2"; +} +.fa-group:before, +.fa-users:before { + content: "\f0c0"; +} +.fa-chain:before, +.fa-link:before { + content: "\f0c1"; +} +.fa-cloud:before { + content: "\f0c2"; +} +.fa-flask:before { + content: "\f0c3"; +} +.fa-cut:before, +.fa-scissors:before { + content: "\f0c4"; +} +.fa-copy:before, +.fa-files-o:before { + content: "\f0c5"; +} +.fa-paperclip:before { + content: "\f0c6"; +} +.fa-save:before, +.fa-floppy-o:before { + content: "\f0c7"; +} +.fa-square:before { + content: "\f0c8"; +} +.fa-navicon:before, +.fa-reorder:before, +.fa-bars:before { + content: "\f0c9"; +} +.fa-list-ul:before { + content: "\f0ca"; +} +.fa-list-ol:before { + content: "\f0cb"; +} +.fa-strikethrough:before { + content: "\f0cc"; +} +.fa-underline:before { + content: "\f0cd"; +} +.fa-table:before { + content: "\f0ce"; +} +.fa-magic:before { + content: "\f0d0"; +} +.fa-truck:before { + content: "\f0d1"; +} +.fa-pinterest:before { + content: "\f0d2"; +} +.fa-pinterest-square:before { + content: "\f0d3"; +} +.fa-google-plus-square:before { + content: "\f0d4"; +} +.fa-google-plus:before { + content: "\f0d5"; +} +.fa-money:before { + content: "\f0d6"; +} +.fa-caret-down:before { + content: "\f0d7"; +} +.fa-caret-up:before { + content: "\f0d8"; +} +.fa-caret-left:before { + content: "\f0d9"; +} +.fa-caret-right:before { + content: "\f0da"; +} +.fa-columns:before { + content: "\f0db"; +} +.fa-unsorted:before, +.fa-sort:before { + content: "\f0dc"; +} +.fa-sort-down:before, +.fa-sort-desc:before { + content: "\f0dd"; +} +.fa-sort-up:before, +.fa-sort-asc:before { + content: "\f0de"; +} +.fa-envelope:before { + content: "\f0e0"; +} +.fa-linkedin:before { + content: "\f0e1"; +} +.fa-rotate-left:before, +.fa-undo:before { + content: "\f0e2"; +} +.fa-legal:before, +.fa-gavel:before { + content: "\f0e3"; +} +.fa-dashboard:before, +.fa-tachometer:before { + content: "\f0e4"; +} +.fa-comment-o:before { + content: "\f0e5"; +} +.fa-comments-o:before { + content: "\f0e6"; +} +.fa-flash:before, +.fa-bolt:before { + content: "\f0e7"; +} +.fa-sitemap:before { + content: "\f0e8"; +} +.fa-umbrella:before { + content: "\f0e9"; +} +.fa-paste:before, +.fa-clipboard:before { + content: "\f0ea"; +} +.fa-lightbulb-o:before { + content: "\f0eb"; +} +.fa-exchange:before { + content: "\f0ec"; +} +.fa-cloud-download:before { + content: "\f0ed"; +} +.fa-cloud-upload:before { + content: "\f0ee"; +} +.fa-user-md:before { + content: "\f0f0"; +} +.fa-stethoscope:before { + content: "\f0f1"; +} +.fa-suitcase:before { + content: "\f0f2"; +} +.fa-bell-o:before { + content: "\f0a2"; +} +.fa-coffee:before { + content: "\f0f4"; +} +.fa-cutlery:before { + content: "\f0f5"; +} +.fa-file-text-o:before { + content: "\f0f6"; +} +.fa-building-o:before { + content: "\f0f7"; +} +.fa-hospital-o:before { + content: "\f0f8"; +} +.fa-ambulance:before { + content: "\f0f9"; +} +.fa-medkit:before { + content: "\f0fa"; +} +.fa-fighter-jet:before { + content: "\f0fb"; +} +.fa-beer:before { + content: "\f0fc"; +} +.fa-h-square:before { + content: "\f0fd"; +} +.fa-plus-square:before { + content: "\f0fe"; +} +.fa-angle-double-left:before { + content: "\f100"; +} +.fa-angle-double-right:before { + content: "\f101"; +} +.fa-angle-double-up:before { + content: "\f102"; +} +.fa-angle-double-down:before { + content: "\f103"; +} +.fa-angle-left:before { + content: "\f104"; +} +.fa-angle-right:before { + content: "\f105"; +} +.fa-angle-up:before { + content: "\f106"; +} +.fa-angle-down:before { + content: "\f107"; +} +.fa-desktop:before { + content: "\f108"; +} +.fa-laptop:before { + content: "\f109"; +} +.fa-tablet:before { + content: "\f10a"; +} +.fa-mobile-phone:before, +.fa-mobile:before { + content: "\f10b"; +} +.fa-circle-o:before { + content: "\f10c"; +} +.fa-quote-left:before { + content: "\f10d"; +} +.fa-quote-right:before { + content: "\f10e"; +} +.fa-spinner:before { + content: "\f110"; +} +.fa-circle:before { + content: "\f111"; +} +.fa-mail-reply:before, +.fa-reply:before { + content: "\f112"; +} +.fa-github-alt:before { + content: "\f113"; +} +.fa-folder-o:before { + content: "\f114"; +} +.fa-folder-open-o:before { + content: "\f115"; +} +.fa-smile-o:before { + content: "\f118"; +} +.fa-frown-o:before { + content: "\f119"; +} +.fa-meh-o:before { + content: "\f11a"; +} +.fa-gamepad:before { + content: "\f11b"; +} +.fa-keyboard-o:before { + content: "\f11c"; +} +.fa-flag-o:before { + content: "\f11d"; +} +.fa-flag-checkered:before { + content: "\f11e"; +} +.fa-terminal:before { + content: "\f120"; +} +.fa-code:before { + content: "\f121"; +} +.fa-mail-reply-all:before, +.fa-reply-all:before { + content: "\f122"; +} +.fa-star-half-empty:before, +.fa-star-half-full:before, +.fa-star-half-o:before { + content: "\f123"; +} +.fa-location-arrow:before { + content: "\f124"; +} +.fa-crop:before { + content: "\f125"; +} +.fa-code-fork:before { + content: "\f126"; +} +.fa-unlink:before, +.fa-chain-broken:before { + content: "\f127"; +} +.fa-question:before { + content: "\f128"; +} +.fa-info:before { + content: "\f129"; +} +.fa-exclamation:before { + content: "\f12a"; +} +.fa-superscript:before { + content: "\f12b"; +} +.fa-subscript:before { + content: "\f12c"; +} +.fa-eraser:before { + content: "\f12d"; +} +.fa-puzzle-piece:before { + content: "\f12e"; +} +.fa-microphone:before { + content: "\f130"; +} +.fa-microphone-slash:before { + content: "\f131"; +} +.fa-shield:before { + content: "\f132"; +} +.fa-calendar-o:before { + content: "\f133"; +} +.fa-fire-extinguisher:before { + content: "\f134"; +} +.fa-rocket:before { + content: "\f135"; +} +.fa-maxcdn:before { + content: "\f136"; +} +.fa-chevron-circle-left:before { + content: "\f137"; +} +.fa-chevron-circle-right:before { + content: "\f138"; +} +.fa-chevron-circle-up:before { + content: "\f139"; +} +.fa-chevron-circle-down:before { + content: "\f13a"; +} +.fa-html5:before { + content: "\f13b"; +} +.fa-css3:before { + content: "\f13c"; +} +.fa-anchor:before { + content: "\f13d"; +} +.fa-unlock-alt:before { + content: "\f13e"; +} +.fa-bullseye:before { + content: "\f140"; +} +.fa-ellipsis-h:before { + content: "\f141"; +} +.fa-ellipsis-v:before { + content: "\f142"; +} +.fa-rss-square:before { + content: "\f143"; +} +.fa-play-circle:before { + content: "\f144"; +} +.fa-ticket:before { + content: "\f145"; +} +.fa-minus-square:before { + content: "\f146"; +} +.fa-minus-square-o:before { + content: "\f147"; +} +.fa-level-up:before { + content: "\f148"; +} +.fa-level-down:before { + content: "\f149"; +} +.fa-check-square:before { + content: "\f14a"; +} +.fa-pencil-square:before { + content: "\f14b"; +} +.fa-external-link-square:before { + content: "\f14c"; +} +.fa-share-square:before { + content: "\f14d"; +} +.fa-compass:before { + content: "\f14e"; +} +.fa-toggle-down:before, +.fa-caret-square-o-down:before { + content: "\f150"; +} +.fa-toggle-up:before, +.fa-caret-square-o-up:before { + content: "\f151"; +} +.fa-toggle-right:before, +.fa-caret-square-o-right:before { + content: "\f152"; +} +.fa-euro:before, +.fa-eur:before { + content: "\f153"; +} +.fa-gbp:before { + content: "\f154"; +} +.fa-dollar:before, +.fa-usd:before { + content: "\f155"; +} +.fa-rupee:before, +.fa-inr:before { + content: "\f156"; +} +.fa-cny:before, +.fa-rmb:before, +.fa-yen:before, +.fa-jpy:before { + content: "\f157"; +} +.fa-ruble:before, +.fa-rouble:before, +.fa-rub:before { + content: "\f158"; +} +.fa-won:before, +.fa-krw:before { + content: "\f159"; +} +.fa-bitcoin:before, +.fa-btc:before { + content: "\f15a"; +} +.fa-file:before { + content: "\f15b"; +} +.fa-file-text:before { + content: "\f15c"; +} +.fa-sort-alpha-asc:before { + content: "\f15d"; +} +.fa-sort-alpha-desc:before { + content: "\f15e"; +} +.fa-sort-amount-asc:before { + content: "\f160"; +} +.fa-sort-amount-desc:before { + content: "\f161"; +} +.fa-sort-numeric-asc:before { + content: "\f162"; +} +.fa-sort-numeric-desc:before { + content: "\f163"; +} +.fa-thumbs-up:before { + content: "\f164"; +} +.fa-thumbs-down:before { + content: "\f165"; +} +.fa-youtube-square:before { + content: "\f166"; +} +.fa-youtube:before { + content: "\f167"; +} +.fa-xing:before { + content: "\f168"; +} +.fa-xing-square:before { + content: "\f169"; +} +.fa-youtube-play:before { + content: "\f16a"; +} +.fa-dropbox:before { + content: "\f16b"; +} +.fa-stack-overflow:before { + content: "\f16c"; +} +.fa-instagram:before { + content: "\f16d"; +} +.fa-flickr:before { + content: "\f16e"; +} +.fa-adn:before { + content: "\f170"; +} +.fa-bitbucket:before { + content: "\f171"; +} +.fa-bitbucket-square:before { + content: "\f172"; +} +.fa-tumblr:before { + content: "\f173"; +} +.fa-tumblr-square:before { + content: "\f174"; +} +.fa-long-arrow-down:before { + content: "\f175"; +} +.fa-long-arrow-up:before { + content: "\f176"; +} +.fa-long-arrow-left:before { + content: "\f177"; +} +.fa-long-arrow-right:before { + content: "\f178"; +} +.fa-apple:before { + content: "\f179"; +} +.fa-windows:before { + content: "\f17a"; +} +.fa-android:before { + content: "\f17b"; +} +.fa-linux:before { + content: "\f17c"; +} +.fa-dribbble:before { + content: "\f17d"; +} +.fa-skype:before { + content: "\f17e"; +} +.fa-foursquare:before { + content: "\f180"; +} +.fa-trello:before { + content: "\f181"; +} +.fa-female:before { + content: "\f182"; +} +.fa-male:before { + content: "\f183"; +} +.fa-gittip:before, +.fa-gratipay:before { + content: "\f184"; +} +.fa-sun-o:before { + content: "\f185"; +} +.fa-moon-o:before { + content: "\f186"; +} +.fa-archive:before { + content: "\f187"; +} +.fa-bug:before { + content: "\f188"; +} +.fa-vk:before { + content: "\f189"; +} +.fa-weibo:before { + content: "\f18a"; +} +.fa-renren:before { + content: "\f18b"; +} +.fa-pagelines:before { + content: "\f18c"; +} +.fa-stack-exchange:before { + content: "\f18d"; +} +.fa-arrow-circle-o-right:before { + content: "\f18e"; +} +.fa-arrow-circle-o-left:before { + content: "\f190"; +} +.fa-toggle-left:before, +.fa-caret-square-o-left:before { + content: "\f191"; +} +.fa-dot-circle-o:before { + content: "\f192"; +} +.fa-wheelchair:before { + content: "\f193"; +} +.fa-vimeo-square:before { + content: "\f194"; +} +.fa-turkish-lira:before, +.fa-try:before { + content: "\f195"; +} +.fa-plus-square-o:before { + content: "\f196"; +} +.fa-space-shuttle:before { + content: "\f197"; +} +.fa-slack:before { + content: "\f198"; +} +.fa-envelope-square:before { + content: "\f199"; +} +.fa-wordpress:before { + content: "\f19a"; +} +.fa-openid:before { + content: "\f19b"; +} +.fa-institution:before, +.fa-bank:before, +.fa-university:before { + content: "\f19c"; +} +.fa-mortar-board:before, +.fa-graduation-cap:before { + content: "\f19d"; +} +.fa-yahoo:before { + content: "\f19e"; +} +.fa-google:before { + content: "\f1a0"; +} +.fa-reddit:before { + content: "\f1a1"; +} +.fa-reddit-square:before { + content: "\f1a2"; +} +.fa-stumbleupon-circle:before { + content: "\f1a3"; +} +.fa-stumbleupon:before { + content: "\f1a4"; +} +.fa-delicious:before { + content: "\f1a5"; +} +.fa-digg:before { + content: "\f1a6"; +} +.fa-pied-piper-pp:before { + content: "\f1a7"; +} +.fa-pied-piper-alt:before { + content: "\f1a8"; +} +.fa-drupal:before { + content: "\f1a9"; +} +.fa-joomla:before { + content: "\f1aa"; +} +.fa-language:before { + content: "\f1ab"; +} +.fa-fax:before { + content: "\f1ac"; +} +.fa-building:before { + content: "\f1ad"; +} +.fa-child:before { + content: "\f1ae"; +} +.fa-paw:before { + content: "\f1b0"; +} +.fa-spoon:before { + content: "\f1b1"; +} +.fa-cube:before { + content: "\f1b2"; +} +.fa-cubes:before { + content: "\f1b3"; +} +.fa-behance:before { + content: "\f1b4"; +} +.fa-behance-square:before { + content: "\f1b5"; +} +.fa-steam:before { + content: "\f1b6"; +} +.fa-steam-square:before { + content: "\f1b7"; +} +.fa-recycle:before { + content: "\f1b8"; +} +.fa-automobile:before, +.fa-car:before { + content: "\f1b9"; +} +.fa-cab:before, +.fa-taxi:before { + content: "\f1ba"; +} +.fa-tree:before { + content: "\f1bb"; +} +.fa-spotify:before { + content: "\f1bc"; +} +.fa-deviantart:before { + content: "\f1bd"; +} +.fa-soundcloud:before { + content: "\f1be"; +} +.fa-database:before { + content: "\f1c0"; +} +.fa-file-pdf-o:before { + content: "\f1c1"; +} +.fa-file-word-o:before { + content: "\f1c2"; +} +.fa-file-excel-o:before { + content: "\f1c3"; +} +.fa-file-powerpoint-o:before { + content: "\f1c4"; +} +.fa-file-photo-o:before, +.fa-file-picture-o:before, +.fa-file-image-o:before { + content: "\f1c5"; +} +.fa-file-zip-o:before, +.fa-file-archive-o:before { + content: "\f1c6"; +} +.fa-file-sound-o:before, +.fa-file-audio-o:before { + content: "\f1c7"; +} +.fa-file-movie-o:before, +.fa-file-video-o:before { + content: "\f1c8"; +} +.fa-file-code-o:before { + content: "\f1c9"; +} +.fa-vine:before { + content: "\f1ca"; +} +.fa-codepen:before { + content: "\f1cb"; +} +.fa-jsfiddle:before { + content: "\f1cc"; +} +.fa-life-bouy:before, +.fa-life-buoy:before, +.fa-life-saver:before, +.fa-support:before, +.fa-life-ring:before { + content: "\f1cd"; +} +.fa-circle-o-notch:before { + content: "\f1ce"; +} +.fa-ra:before, +.fa-resistance:before, +.fa-rebel:before { + content: "\f1d0"; +} +.fa-ge:before, +.fa-empire:before { + content: "\f1d1"; +} +.fa-git-square:before { + content: "\f1d2"; +} +.fa-git:before { + content: "\f1d3"; +} +.fa-y-combinator-square:before, +.fa-yc-square:before, +.fa-hacker-news:before { + content: "\f1d4"; +} +.fa-tencent-weibo:before { + content: "\f1d5"; +} +.fa-qq:before { + content: "\f1d6"; +} +.fa-wechat:before, +.fa-weixin:before { + content: "\f1d7"; +} +.fa-send:before, +.fa-paper-plane:before { + content: "\f1d8"; +} +.fa-send-o:before, +.fa-paper-plane-o:before { + content: "\f1d9"; +} +.fa-history:before { + content: "\f1da"; +} +.fa-circle-thin:before { + content: "\f1db"; +} +.fa-header:before { + content: "\f1dc"; +} +.fa-paragraph:before { + content: "\f1dd"; +} +.fa-sliders:before { + content: "\f1de"; +} +.fa-share-alt:before { + content: "\f1e0"; +} +.fa-share-alt-square:before { + content: "\f1e1"; +} +.fa-bomb:before { + content: "\f1e2"; +} +.fa-soccer-ball-o:before, +.fa-futbol-o:before { + content: "\f1e3"; +} +.fa-tty:before { + content: "\f1e4"; +} +.fa-binoculars:before { + content: "\f1e5"; +} +.fa-plug:before { + content: "\f1e6"; +} +.fa-slideshare:before { + content: "\f1e7"; +} +.fa-twitch:before { + content: "\f1e8"; +} +.fa-yelp:before { + content: "\f1e9"; +} +.fa-newspaper-o:before { + content: "\f1ea"; +} +.fa-wifi:before { + content: "\f1eb"; +} +.fa-calculator:before { + content: "\f1ec"; +} +.fa-paypal:before { + content: "\f1ed"; +} +.fa-google-wallet:before { + content: "\f1ee"; +} +.fa-cc-visa:before { + content: "\f1f0"; +} +.fa-cc-mastercard:before { + content: "\f1f1"; +} +.fa-cc-discover:before { + content: "\f1f2"; +} +.fa-cc-amex:before { + content: "\f1f3"; +} +.fa-cc-paypal:before { + content: "\f1f4"; +} +.fa-cc-stripe:before { + content: "\f1f5"; +} +.fa-bell-slash:before { + content: "\f1f6"; +} +.fa-bell-slash-o:before { + content: "\f1f7"; +} +.fa-trash:before { + content: "\f1f8"; +} +.fa-copyright:before { + content: "\f1f9"; +} +.fa-at:before { + content: "\f1fa"; +} +.fa-eyedropper:before { + content: "\f1fb"; +} +.fa-paint-brush:before { + content: "\f1fc"; +} +.fa-birthday-cake:before { + content: "\f1fd"; +} +.fa-area-chart:before { + content: "\f1fe"; +} +.fa-pie-chart:before { + content: "\f200"; +} +.fa-line-chart:before { + content: "\f201"; +} +.fa-lastfm:before { + content: "\f202"; +} +.fa-lastfm-square:before { + content: "\f203"; +} +.fa-toggle-off:before { + content: "\f204"; +} +.fa-toggle-on:before { + content: "\f205"; +} +.fa-bicycle:before { + content: "\f206"; +} +.fa-bus:before { + content: "\f207"; +} +.fa-ioxhost:before { + content: "\f208"; +} +.fa-angellist:before { + content: "\f209"; +} +.fa-cc:before { + content: "\f20a"; +} +.fa-shekel:before, +.fa-sheqel:before, +.fa-ils:before { + content: "\f20b"; +} +.fa-meanpath:before { + content: "\f20c"; +} +.fa-buysellads:before { + content: "\f20d"; +} +.fa-connectdevelop:before { + content: "\f20e"; +} +.fa-dashcube:before { + content: "\f210"; +} +.fa-forumbee:before { + content: "\f211"; +} +.fa-leanpub:before { + content: "\f212"; +} +.fa-sellsy:before { + content: "\f213"; +} +.fa-shirtsinbulk:before { + content: "\f214"; +} +.fa-simplybuilt:before { + content: "\f215"; +} +.fa-skyatlas:before { + content: "\f216"; +} +.fa-cart-plus:before { + content: "\f217"; +} +.fa-cart-arrow-down:before { + content: "\f218"; +} +.fa-diamond:before { + content: "\f219"; +} +.fa-ship:before { + content: "\f21a"; +} +.fa-user-secret:before { + content: "\f21b"; +} +.fa-motorcycle:before { + content: "\f21c"; +} +.fa-street-view:before { + content: "\f21d"; +} +.fa-heartbeat:before { + content: "\f21e"; +} +.fa-venus:before { + content: "\f221"; +} +.fa-mars:before { + content: "\f222"; +} +.fa-mercury:before { + content: "\f223"; +} +.fa-intersex:before, +.fa-transgender:before { + content: "\f224"; +} +.fa-transgender-alt:before { + content: "\f225"; +} +.fa-venus-double:before { + content: "\f226"; +} +.fa-mars-double:before { + content: "\f227"; +} +.fa-venus-mars:before { + content: "\f228"; +} +.fa-mars-stroke:before { + content: "\f229"; +} +.fa-mars-stroke-v:before { + content: "\f22a"; +} +.fa-mars-stroke-h:before { + content: "\f22b"; +} +.fa-neuter:before { + content: "\f22c"; +} +.fa-genderless:before { + content: "\f22d"; +} +.fa-facebook-official:before { + content: "\f230"; +} +.fa-pinterest-p:before { + content: "\f231"; +} +.fa-whatsapp:before { + content: "\f232"; +} +.fa-server:before { + content: "\f233"; +} +.fa-user-plus:before { + content: "\f234"; +} +.fa-user-times:before { + content: "\f235"; +} +.fa-hotel:before, +.fa-bed:before { + content: "\f236"; +} +.fa-viacoin:before { + content: "\f237"; +} +.fa-train:before { + content: "\f238"; +} +.fa-subway:before { + content: "\f239"; +} +.fa-medium:before { + content: "\f23a"; +} +.fa-yc:before, +.fa-y-combinator:before { + content: "\f23b"; +} +.fa-optin-monster:before { + content: "\f23c"; +} +.fa-opencart:before { + content: "\f23d"; +} +.fa-expeditedssl:before { + content: "\f23e"; +} +.fa-battery-4:before, +.fa-battery:before, +.fa-battery-full:before { + content: "\f240"; +} +.fa-battery-3:before, +.fa-battery-three-quarters:before { + content: "\f241"; +} +.fa-battery-2:before, +.fa-battery-half:before { + content: "\f242"; +} +.fa-battery-1:before, +.fa-battery-quarter:before { + content: "\f243"; +} +.fa-battery-0:before, +.fa-battery-empty:before { + content: "\f244"; +} +.fa-mouse-pointer:before { + content: "\f245"; +} +.fa-i-cursor:before { + content: "\f246"; +} +.fa-object-group:before { + content: "\f247"; +} +.fa-object-ungroup:before { + content: "\f248"; +} +.fa-sticky-note:before { + content: "\f249"; +} +.fa-sticky-note-o:before { + content: "\f24a"; +} +.fa-cc-jcb:before { + content: "\f24b"; +} +.fa-cc-diners-club:before { + content: "\f24c"; +} +.fa-clone:before { + content: "\f24d"; +} +.fa-balance-scale:before { + content: "\f24e"; +} +.fa-hourglass-o:before { + content: "\f250"; +} +.fa-hourglass-1:before, +.fa-hourglass-start:before { + content: "\f251"; +} +.fa-hourglass-2:before, +.fa-hourglass-half:before { + content: "\f252"; +} +.fa-hourglass-3:before, +.fa-hourglass-end:before { + content: "\f253"; +} +.fa-hourglass:before { + content: "\f254"; +} +.fa-hand-grab-o:before, +.fa-hand-rock-o:before { + content: "\f255"; +} +.fa-hand-stop-o:before, +.fa-hand-paper-o:before { + content: "\f256"; +} +.fa-hand-scissors-o:before { + content: "\f257"; +} +.fa-hand-lizard-o:before { + content: "\f258"; +} +.fa-hand-spock-o:before { + content: "\f259"; +} +.fa-hand-pointer-o:before { + content: "\f25a"; +} +.fa-hand-peace-o:before { + content: "\f25b"; +} +.fa-trademark:before { + content: "\f25c"; +} +.fa-registered:before { + content: "\f25d"; +} +.fa-creative-commons:before { + content: "\f25e"; +} +.fa-gg:before { + content: "\f260"; +} +.fa-gg-circle:before { + content: "\f261"; +} +.fa-tripadvisor:before { + content: "\f262"; +} +.fa-odnoklassniki:before { + content: "\f263"; +} +.fa-odnoklassniki-square:before { + content: "\f264"; +} +.fa-get-pocket:before { + content: "\f265"; +} +.fa-wikipedia-w:before { + content: "\f266"; +} +.fa-safari:before { + content: "\f267"; +} +.fa-chrome:before { + content: "\f268"; +} +.fa-firefox:before { + content: "\f269"; +} +.fa-opera:before { + content: "\f26a"; +} +.fa-internet-explorer:before { + content: "\f26b"; +} +.fa-tv:before, +.fa-television:before { + content: "\f26c"; +} +.fa-contao:before { + content: "\f26d"; +} +.fa-500px:before { + content: "\f26e"; +} +.fa-amazon:before { + content: "\f270"; +} +.fa-calendar-plus-o:before { + content: "\f271"; +} +.fa-calendar-minus-o:before { + content: "\f272"; +} +.fa-calendar-times-o:before { + content: "\f273"; +} +.fa-calendar-check-o:before { + content: "\f274"; +} +.fa-industry:before { + content: "\f275"; +} +.fa-map-pin:before { + content: "\f276"; +} +.fa-map-signs:before { + content: "\f277"; +} +.fa-map-o:before { + content: "\f278"; +} +.fa-map:before { + content: "\f279"; +} +.fa-commenting:before { + content: "\f27a"; +} +.fa-commenting-o:before { + content: "\f27b"; +} +.fa-houzz:before { + content: "\f27c"; +} +.fa-vimeo:before { + content: "\f27d"; +} +.fa-black-tie:before { + content: "\f27e"; +} +.fa-fonticons:before { + content: "\f280"; +} +.fa-reddit-alien:before { + content: "\f281"; +} +.fa-edge:before { + content: "\f282"; +} +.fa-credit-card-alt:before { + content: "\f283"; +} +.fa-codiepie:before { + content: "\f284"; +} +.fa-modx:before { + content: "\f285"; +} +.fa-fort-awesome:before { + content: "\f286"; +} +.fa-usb:before { + content: "\f287"; +} +.fa-product-hunt:before { + content: "\f288"; +} +.fa-mixcloud:before { + content: "\f289"; +} +.fa-scribd:before { + content: "\f28a"; +} +.fa-pause-circle:before { + content: "\f28b"; +} +.fa-pause-circle-o:before { + content: "\f28c"; +} +.fa-stop-circle:before { + content: "\f28d"; +} +.fa-stop-circle-o:before { + content: "\f28e"; +} +.fa-shopping-bag:before { + content: "\f290"; +} +.fa-shopping-basket:before { + content: "\f291"; +} +.fa-hashtag:before { + content: "\f292"; +} +.fa-bluetooth:before { + content: "\f293"; +} +.fa-bluetooth-b:before { + content: "\f294"; +} +.fa-percent:before { + content: "\f295"; +} +.fa-gitlab:before { + content: "\f296"; +} +.fa-wpbeginner:before { + content: "\f297"; +} +.fa-wpforms:before { + content: "\f298"; +} +.fa-envira:before { + content: "\f299"; +} +.fa-universal-access:before { + content: "\f29a"; +} +.fa-wheelchair-alt:before { + content: "\f29b"; +} +.fa-question-circle-o:before { + content: "\f29c"; +} +.fa-blind:before { + content: "\f29d"; +} +.fa-audio-description:before { + content: "\f29e"; +} +.fa-volume-control-phone:before { + content: "\f2a0"; +} +.fa-braille:before { + content: "\f2a1"; +} +.fa-assistive-listening-systems:before { + content: "\f2a2"; +} +.fa-asl-interpreting:before, +.fa-american-sign-language-interpreting:before { + content: "\f2a3"; +} +.fa-deafness:before, +.fa-hard-of-hearing:before, +.fa-deaf:before { + content: "\f2a4"; +} +.fa-glide:before { + content: "\f2a5"; +} +.fa-glide-g:before { + content: "\f2a6"; +} +.fa-signing:before, +.fa-sign-language:before { + content: "\f2a7"; +} +.fa-low-vision:before { + content: "\f2a8"; +} +.fa-viadeo:before { + content: "\f2a9"; +} +.fa-viadeo-square:before { + content: "\f2aa"; +} +.fa-snapchat:before { + content: "\f2ab"; +} +.fa-snapchat-ghost:before { + content: "\f2ac"; +} +.fa-snapchat-square:before { + content: "\f2ad"; +} +.fa-pied-piper:before { + content: "\f2ae"; +} +.fa-first-order:before { + content: "\f2b0"; +} +.fa-yoast:before { + content: "\f2b1"; +} +.fa-themeisle:before { + content: "\f2b2"; +} +.fa-google-plus-circle:before, +.fa-google-plus-official:before { + content: "\f2b3"; +} +.fa-fa:before, +.fa-font-awesome:before { + content: "\f2b4"; +} +.fa-handshake-o:before { + content: "\f2b5"; +} +.fa-envelope-open:before { + content: "\f2b6"; +} +.fa-envelope-open-o:before { + content: "\f2b7"; +} +.fa-linode:before { + content: "\f2b8"; +} +.fa-address-book:before { + content: "\f2b9"; +} +.fa-address-book-o:before { + content: "\f2ba"; +} +.fa-vcard:before, +.fa-address-card:before { + content: "\f2bb"; +} +.fa-vcard-o:before, +.fa-address-card-o:before { + content: "\f2bc"; +} +.fa-user-circle:before { + content: "\f2bd"; +} +.fa-user-circle-o:before { + content: "\f2be"; +} +.fa-user-o:before { + content: "\f2c0"; +} +.fa-id-badge:before { + content: "\f2c1"; +} +.fa-drivers-license:before, +.fa-id-card:before { + content: "\f2c2"; +} +.fa-drivers-license-o:before, +.fa-id-card-o:before { + content: "\f2c3"; +} +.fa-quora:before { + content: "\f2c4"; +} +.fa-free-code-camp:before { + content: "\f2c5"; +} +.fa-telegram:before { + content: "\f2c6"; +} +.fa-thermometer-4:before, +.fa-thermometer:before, +.fa-thermometer-full:before { + content: "\f2c7"; +} +.fa-thermometer-3:before, +.fa-thermometer-three-quarters:before { + content: "\f2c8"; +} +.fa-thermometer-2:before, +.fa-thermometer-half:before { + content: "\f2c9"; +} +.fa-thermometer-1:before, +.fa-thermometer-quarter:before { + content: "\f2ca"; +} +.fa-thermometer-0:before, +.fa-thermometer-empty:before { + content: "\f2cb"; +} +.fa-shower:before { + content: "\f2cc"; +} +.fa-bathtub:before, +.fa-s15:before, +.fa-bath:before { + content: "\f2cd"; +} +.fa-podcast:before { + content: "\f2ce"; +} +.fa-window-maximize:before { + content: "\f2d0"; +} +.fa-window-minimize:before { + content: "\f2d1"; +} +.fa-window-restore:before { + content: "\f2d2"; +} +.fa-times-rectangle:before, +.fa-window-close:before { + content: "\f2d3"; +} +.fa-times-rectangle-o:before, +.fa-window-close-o:before { + content: "\f2d4"; +} +.fa-bandcamp:before { + content: "\f2d5"; +} +.fa-grav:before { + content: "\f2d6"; +} +.fa-etsy:before { + content: "\f2d7"; +} +.fa-imdb:before { + content: "\f2d8"; +} +.fa-ravelry:before { + content: "\f2d9"; +} +.fa-eercast:before { + content: "\f2da"; +} +.fa-microchip:before { + content: "\f2db"; +} +.fa-snowflake-o:before { + content: "\f2dc"; +} +.fa-superpowers:before { + content: "\f2dd"; +} +.fa-wpexplorer:before { + content: "\f2de"; +} +.fa-meetup:before { + content: "\f2e0"; +} +.sr-only { + position: absolute; + width: 1px; + height: 1px; + padding: 0; + margin: -1px; + overflow: hidden; + clip: rect(0, 0, 0, 0); + border: 0; +} +.sr-only-focusable:active, +.sr-only-focusable:focus { + position: static; + width: auto; + height: auto; + margin: 0; + overflow: visible; + clip: auto; +} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css.map b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css.map new file mode 100755 index 0000000000000..60763a8640f1c --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": ";;;;;;;AAGA,UAUC;EATC,WAAW,EAAE,aAAa;EAC1B,GAAG,EAAE,+CAAgE;EACrE,GAAG,EAAE,ySAAmG;EAKxG,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;ACTpB,GAAmB;EACjB,OAAO,EAAE,YAAY;EACrB,IAAI,EAAE,uCAAwD;EAC9D,SAAS,EAAE,OAAO;EAClB,cAAc,EAAE,IAAI;EACpB,sBAAsB,EAAE,WAAW;EACnC,uBAAuB,EAAE,SAAS;EAClC,SAAS,EAAE,eAAe;;;ACN5B,MAAsB;EACpB,SAAS,EAAE,SAAS;EACpB,WAAW,EAAE,MAAS;EACtB,cAAc,EAAE,IAAI;;AAEtB,MAAsB;EAAE,SAAS,EAAE,GAAG;;AACtC,MAAsB;EAAE,SAAS,EAAE,GAAG;;AACtC,MAAsB;EAAE,SAAS,EAAE,GAAG;;AACtC,MAAsB;EAAE,SAAS,EAAE,GAAG;;ACVtC,MAAsB;EACpB,KAAK,EAAE,SAAW;EAClB,UAAU,EAAE,MAAM;;ACDpB,MAAsB;EACpB,YAAY,EAAE,CAAC;EACf,WAAW,ECKU,SAAS;EDJ9B,eAAe,EAAE,IAAI;EACrB,WAAK;IAAE,QAAQ,EAAE,QAAQ;;AAE3B,MAAsB;EACpB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,UAAa;EACnB,KAAK,ECFgB,SAAS;EDG9B,GAAG,EAAE,SAAU;EACf,UAAU,EAAE,MAAM;EAClB,YAAuB;IACrB,IAAI,EAAE,UAA0B;;AEbpC,UAA0B;EACxB,OAAO,EAAE,gBAAgB;EACzB,MAAM,EAAE,iBAA4B;EACpC,aAAa,EAAE,IAAI;;AAGrB,WAAY;EAAE,KAAK,EAAE,KAAK;;AAC1B,UAAW;EAAE,KAAK,EAAE,IAAI;;AAGtB,aAAY;EAAE,YAAY,EAAE,IAAI;AAChC,cAAa;EAAE,WAAW,EAAE,IAAI;;ACXlC,QAAwB;EACtB,iBAAiB,EAAE,0BAA0B;EACrC,SAAS,EAAE,0BAA0B;;AAG/C,SAAyB;EACvB,iBAAiB,EAAE,4BAA4B;EACvC,SAAS,EAAE,4BAA4B;;AAGjD,0BASC;EARC,EAAG;IACD,iBAAiB,EAAE,YAAY;IACvB,SAAS,EAAE,YAAY;EAEjC,IAAK;IACH,iBAAiB,EAAE,cAAc;IACzB,SAAS,EAAE,cAAc;AAIrC,kBASC;EARC,EAAG;IACD,iBAAiB,EAAE,YAAY;IACvB,SAAS,EAAE,YAAY;EAEjC,IAAK;IACH,iBAAiB,EAAE,cAAc;IACzB,SAAS,EAAE,cAAc;AC5BrC,aAA8B;ECY5B,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,aAAgB;EAC/B,aAAa,EAAE,aAAgB;EAC3B,SAAS,EAAE,aAAgB;;ADdrC,cAA8B;ECW5B,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,cAAgB;EAC/B,aAAa,EAAE,cAAgB;EAC3B,SAAS,EAAE,cAAgB;;ADbrC,cAA8B;ECU5B,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,cAAgB;EAC/B,aAAa,EAAE,cAAgB;EAC3B,SAAS,EAAE,cAAgB;;ADXrC,mBAAmC;ECejC,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,YAAoB;EACnC,aAAa,EAAE,YAAoB;EAC/B,SAAS,EAAE,YAAoB;;ADjBzC,iBAAmC;ECcjC,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,YAAoB;EACnC,aAAa,EAAE,YAAoB;EAC/B,SAAS,EAAE,YAAoB;;ADZzC;;;;uBAIuC;EACrC,MAAM,EAAE,IAAI;;AEfd,SAAyB;EACvB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,YAAY;EACrB,KAAK,EAAE,GAAG;EACV,MAAM,EAAE,GAAG;EACX,WAAW,EAAE,GAAG;EAChB,cAAc,EAAE,MAAM;;AAExB,0BAAyD;EACvD,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,CAAC;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAEpB,YAA4B;EAAE,WAAW,EAAE,OAAO;;AAClD,YAA4B;EAAE,SAAS,EAAE,GAAG;;AAC5C,WAA2B;EAAE,KAAK,ELVZ,IAAI;;;;AMN1B,gBAAgC;EAAE,OAAO,ENoQ1B,GAAO;;AMnQtB,gBAAgC;EAAE,OAAO,EN0W1B,GAAO;;AMzWtB,iBAAiC;EAAE,OAAO,ENmb1B,GAAO;;AMlbvB,qBAAqC;EAAE,OAAO,ENmL1B,GAAO;;AMlL3B,gBAAgC;EAAE,OAAO,ENkR1B,GAAO;;AMjRtB,eAA+B;EAAE,OAAO,ENke1B,GAAO;;AMjerB,iBAAiC;EAAE,OAAO,ENse1B,GAAO;;AMrevB,eAA+B;EAAE,OAAO,EN+iB1B,GAAO;;AM9iBrB,eAA+B;EAAE,OAAO,ENyN1B,GAAO;;AMxNrB,mBAAmC;EAAE,OAAO,ENggB1B,GAAO;;AM/fzB,aAA6B;EAAE,OAAO,EN8f1B,GAAO;;AM7fnB,kBAAkC;EAAE,OAAO,EN+f1B,GAAO;;AM9fxB,gBAAgC;EAAE,OAAO,ENoG1B,GAAO;;AMnGtB;;gBAEgC;EAAE,OAAO,ENkgB1B,GAAO;;AMjgBtB,sBAAsC;EAAE,OAAO,ENua1B,GAAO;;AMta5B,uBAAuC;EAAE,OAAO,ENqa1B,GAAO;;AMpa7B,oBAAoC;EAAE,OAAO,EN+X1B,GAAO;;AM9X1B,iBAAiC;EAAE,OAAO,ENsb1B,GAAO;;AMrbvB;cAC8B;EAAE,OAAO,ENwH1B,GAAO;;AMvHpB,kBAAkC;EAAE,OAAO,ENygB1B,GAAO;;AMxgBxB,eAA+B;EAAE,OAAO,ENmQ1B,GAAO;;AMlQrB,iBAAiC;EAAE,OAAO,EN6L1B,GAAO;;AM5LvB,kBAAkC;EAAE,OAAO,EN0G1B,GAAO;;AMzGxB,eAA+B;EAAE,OAAO,EN+Y1B,GAAO;;AM9YrB,mBAAmC;EAAE,OAAO,ENiJ1B,GAAO;;AMhJzB,8BAA8C;EAAE,OAAO,ENI1B,GAAO;;AMHpC,4BAA4C;EAAE,OAAO,ENM1B,GAAO;;AMLlC,gBAAgC;EAAE,OAAO,ENkQ1B,GAAO;;AMjQtB,wBAAwC;EAAE,OAAO,EN4W1B,GAAO;;AM3W9B;iBACiC;EAAE,OAAO,ENmY1B,GAAO;;AMlYvB,kBAAkC;EAAE,OAAO,EN8X1B,GAAO;;AM7XxB,mBAAmC;EAAE,OAAO,ENiS1B,GAAO;;AMhSzB,eAA+B;EAAE,OAAO,ENoS1B,GAAO;;AMnSrB,eAA+B;EAAE,OAAO,ENgM1B,GAAO;;AM/LrB,qBAAqC;EAAE,OAAO,EN+O1B,GAAO;;AM9O3B,qBAAqC;EAAE,OAAO,EN8hB1B,GAAO;;AM7hB3B,sBAAsC;EAAE,OAAO,EN4hB1B,GAAO;;AM3hB5B,oBAAoC;EAAE,OAAO,EN6hB1B,GAAO;;AM5hB1B,iBAAiC;EAAE,OAAO,EN2W1B,GAAO;;AM1WvB,kBAAkC;EAAE,OAAO,ENW1B,GAAO;;AMVxB,cAA8B;EAAE,OAAO,ENod1B,GAAO;;AMndpB,eAA+B;EAAE,OAAO,ENod1B,GAAO;;AMndrB,eAA+B;EAAE,OAAO,EN2B1B,GAAO;;AM1BrB,mBAAmC;EAAE,OAAO,EN2B1B,GAAO;;AM1BzB,gBAAgC;EAAE,OAAO,ENkW1B,GAAO;;AMjWtB,iBAAiC;EAAE,OAAO,ENwC1B,GAAO;;AMvCvB,eAA+B;EAAE,OAAO,EN8L1B,GAAO;;AM7LrB,eAA+B;EAAE,OAAO,ENmB1B,GAAO;;AMlBrB,iBAAiC;EAAE,OAAO,ENoP1B,GAAO;;AMnPvB,sBAAsC;EAAE,OAAO,ENid1B,GAAO;;AMhd5B,qBAAqC;EAAE,OAAO,ENid1B,GAAO;;AMhd3B,qBAAqC;EAAE,OAAO,EN1C1B,GAAO;;AM2C3B,uBAAuC;EAAE,OAAO,EN7C1B,GAAO;;AM8C7B,sBAAsC;EAAE,OAAO,EN3C1B,GAAO;;AM4C5B,wBAAwC;EAAE,OAAO,EN9C1B,GAAO;;AM+C9B,eAA+B;EAAE,OAAO,ENwQ1B,GAAO;;AMvQrB;kBACkC;EAAE,OAAO,ENmT1B,GAAO;;AMlTxB,iBAAiC;EAAE,OAAO,ENmO1B,GAAO;;AMlOvB,uBAAuC;EAAE,OAAO,ENigB1B,GAAO;;AMhgB7B;;oBAEoC;EAAE,OAAO,EN+T1B,GAAO;;AM9T1B,iBAAiC;EAAE,OAAO,ENwT1B,GAAO;;AMvTvB,qBAAqC;EAAE,OAAO,EN+Q1B,GAAO;;AM9Q3B,iBAAiC;EAAE,OAAO,EN5D1B,GAAO;;AM6DvB,eAA+B;EAAE,OAAO,EN8c1B,GAAO;;AM7crB;0BAC0C;EAAE,OAAO,ENqT1B,GAAO;;AMpThC,yBAAyC;EAAE,OAAO,ENuX1B,GAAO;;AMtX/B,yBAAyC;EAAE,OAAO,EN0C1B,GAAO;;AMzC/B,iBAAiC;EAAE,OAAO,ENjC1B,GAAO;;AMkCvB,wBAAwC;EAAE,OAAO,ENma1B,GAAO;;AMla9B,wBAAwC;EAAE,OAAO,EN4H1B,GAAO;;AM3H9B,mBAAmC;EAAE,OAAO,EN7B1B,GAAO;;AM8BzB,eAA+B;EAAE,OAAO,EN0T1B,GAAO;;AMzTrB,gBAAgC;EAAE,OAAO,ENwS1B,GAAO;;AMvStB,eAA+B;EAAE,OAAO,ENia1B,GAAO;;AMharB,kBAAkC;EAAE,OAAO,ENgK1B,GAAO;;AM/JxB,uBAAuC;EAAE,OAAO,ENuH1B,GAAO;;AMtH7B,uBAAuC;EAAE,OAAO,EN4Z1B,GAAO;;AM3Z7B,gBAAgC;EAAE,OAAO,EN4F1B,GAAO;;AM3FtB,uBAAuC;EAAE,OAAO,ENoC1B,GAAO;;AMnC7B,wBAAwC;EAAE,OAAO,ENoC1B,GAAO;;AMnC9B,sBAAsC;EAAE,OAAO,ENsT1B,GAAO;;AMrT5B,uBAAuC;EAAE,OAAO,ENyQ1B,GAAO;;AMxQ7B,uBAAuC;EAAE,OAAO,ENwb1B,GAAO;;AMvb7B,uBAAuC;EAAE,OAAO,ENsB1B,GAAO;;AMrB7B,0BAA0C;EAAE,OAAO,EN2T1B,GAAO;;AM1ThC,sBAAsC;EAAE,OAAO,ENsM1B,GAAO;;AMrM5B,qBAAqC;EAAE,OAAO,EN6D1B,GAAO;;AM5D3B,yBAAyC;EAAE,OAAO,ENob1B,GAAO;;AMnb/B,yBAAyC;EAAE,OAAO,ENkB1B,GAAO;;AMjB/B,cAA8B;EAAE,OAAO,EN/C1B,GAAO;;AMgDpB,qBAAqC;EAAE,OAAO,EN3D1B,GAAO;;AM4D3B,sBAAsC;EAAE,OAAO,EN3D1B,GAAO;;AM4D5B,mBAAmC;EAAE,OAAO,EN3D1B,GAAO;;AM4DzB,qBAAqC;EAAE,OAAO,EN/D1B,GAAO;;AMgE3B;gBACgC;EAAE,OAAO,ENqV1B,GAAO;;AMpVtB,iBAAiC;EAAE,OAAO,ENuF1B,GAAO;;AMtFvB,mBAAmC;EAAE,OAAO,EN4C1B,GAAO;;AM3CzB,eAA+B;EAAE,OAAO,ENmS1B,GAAO;;AMlSrB,gBAAgC;EAAE,OAAO,ENsP1B,GAAO;;AMrPtB,mBAAmC;EAAE,OAAO,EN9D1B,GAAO;;AM+DzB,6BAA6C;EAAE,OAAO,ENgF1B,GAAO;;AM/EnC,eAA+B;EAAE,OAAO,EN+I1B,GAAO;;AM9IrB,eAA+B;EAAE,OAAO,ENoM1B,GAAO;;AMnMrB,eAA+B;EAAE,OAAO,ENmH1B,GAAO;;AMlHrB,cAA8B;EAAE,OAAO,ENiF1B,GAAO;;AMhFpB,oBAAoC;EAAE,OAAO,ENiF1B,GAAO;;AMhF1B;+BAC+C;EAAE,OAAO,EN0E1B,GAAO;;AMzErC,gBAAgC;EAAE,OAAO,ENmR1B,GAAO;;AMlRtB,mBAAmC;EAAE,OAAO,EN/B1B,GAAO;;AMgCzB,iBAAiC;EAAE,OAAO,ENoS1B,GAAO;;AMnSvB,kBAAkC;EAAE,OAAO,ENwB1B,GAAO;;AMvBxB,iBAAiC;EAAE,OAAO,ENqN1B,GAAO;;AMpNvB,qBAAqC;EAAE,OAAO,ENE1B,GAAO;;AMD3B,uBAAuC;EAAE,OAAO,ENF1B,GAAO;;AMG7B,kBAAkC;EAAE,OAAO,EN2S1B,GAAO;;AM1SxB,wBAAwC;EAAE,OAAO,ENyU1B,GAAO;;AMxU9B,iBAAiC;EAAE,OAAO,EN8G1B,GAAO;;AM7GvB,sBAAsC;EAAE,OAAO,EN+G1B,GAAO;;AM9G5B,mBAAmC;EAAE,OAAO,ENnF1B,GAAO;;AMoFzB,mBAAmC;EAAE,OAAO,ENrF1B,GAAO;;AMsFzB;oBACoC;EAAE,OAAO,EN/E1B,GAAO;;AMgF1B,yBAAyC;EAAE,OAAO,ENua1B,GAAO;;AMta/B,0BAA0C;EAAE,OAAO,ENmE1B,GAAO;;AMlEhC,uBAAuC;EAAE,OAAO,EN5C1B,GAAO;;AM6C7B,cAA8B;EAAE,OAAO,ENqK1B,GAAO;;AMpKpB;eAC+B;EAAE,OAAO,ENK1B,GAAO;;AMJrB,mBAAmC;EAAE,OAAO,ENQ1B,GAAO;;AMPzB,sBAAsC;EAAE,OAAO,ENmY1B,GAAO;;AMlY5B,wBAAwC;EAAE,OAAO,ENiY1B,GAAO;;AMhY9B,oBAAoC;EAAE,OAAO,EN2V1B,GAAO;;AM1V1B,kBAAkC;EAAE,OAAO,ENyI1B,GAAO;;AMxIxB,mBAAmC;EAAE,OAAO,ENyT1B,GAAO;;AMxTzB,0BAA0C;EAAE,OAAO,ENiL1B,GAAO;;AMhLhC,qBAAqC;EAAE,OAAO,EN0X1B,GAAO;;AMzX3B,wBAAwC;EAAE,OAAO,EN8C1B,GAAO;;AM7C9B,kBAAkC;EAAE,OAAO,ENoT1B,GAAO;;AMnTxB,iBAAiC;EAAE,OAAO,EN8Y1B,GAAO;;AM7YvB,wBAAwC;EAAE,OAAO,EN6G1B,GAAO;;AM5G9B,iBAAiC;EAAE,OAAO,EN8Z1B,GAAO;;AM7ZvB,kBAAkC;EAAE,OAAO,EN+J1B,GAAO;;AM9JxB,gBAAgC;EAAE,OAAO,ENsO1B,GAAO;;AMrOtB,mBAAmC;EAAE,OAAO,EN2U1B,GAAO;;AM1UzB,qBAAqC;EAAE,OAAO,EN/E1B,GAAO;;AMgF3B,uBAAuC;EAAE,OAAO,ENoO1B,GAAO;;AMnO7B,kBAAkC;EAAE,OAAO,EN8Y1B,GAAO;;AM7YxB;mBACmC;EAAE,OAAO,ENuC1B,GAAO;;AMtCzB,iBAAiC;EAAE,OAAO,ENiG1B,GAAO;;AMhGvB,iBAAiC;EAAE,OAAO,ENiZ1B,GAAO;;AMhZvB,sBAAsC;EAAE,OAAO,ENR1B,GAAO;;AMS5B,cAA8B;EAAE,OAAO,EN4Q1B,GAAO;;AM3QpB,gBAAgC;EAAE,OAAO,ENgH1B,GAAO;;AM/GtB,mBAAmC;EAAE,OAAO,ENnF1B,GAAO;;AMoFzB,eAA+B;EAAE,OAAO,ENzG1B,GAAO;;AM0GrB,sBAAsC;EAAE,OAAO,ENzD1B,GAAO;;AM0D5B,uBAAuC;EAAE,OAAO,EN0G1B,GAAO;;AMzG7B,sBAAsC;EAAE,OAAO,ENwG1B,GAAO;;AMvG5B,oBAAoC;EAAE,OAAO,ENyG1B,GAAO;;AMxG1B,sBAAsC;EAAE,OAAO,ENqG1B,GAAO;;AMpG5B,4BAA4C;EAAE,OAAO,EN5I1B,GAAO;;AM6IlC,6BAA6C;EAAE,OAAO,ENxI1B,GAAO;;AMyInC,0BAA0C;EAAE,OAAO,ENxI1B,GAAO;;AMyIhC,4BAA4C;EAAE,OAAO,ENhJ1B,GAAO;;AMiJlC,gBAAgC;EAAE,OAAO,ENsF1B,GAAO;;AMrFtB,iBAAiC;EAAE,OAAO,ENia1B,GAAO;;AMhavB,gBAAgC;EAAE,OAAO,ENiV1B,GAAO;;AMhVtB,iBAAiC;EAAE,OAAO,ENgD1B,GAAO;;AM/CvB,oBAAoC;EAAE,OAAO,ENvG1B,GAAO;;AMwG1B,qBAAqC;EAAE,OAAO,ENzI1B,GAAO;;AM0I3B;gBACgC;EAAE,OAAO,ENqY1B,GAAO;;AMpYtB;eAC+B;EAAE,OAAO,ENuI1B,GAAO;;AMtIrB,gBAAgC;EAAE,OAAO,ENpD1B,GAAO;;AMqDtB,gBAAgC;EAAE,OAAO,EN+C1B,GAAO;;AM9CtB;mBACmC;EAAE,OAAO,ENwP1B,GAAO;;AMvPzB;kBACkC;EAAE,OAAO,ENkC1B,GAAO;;AMjCxB,oBAAoC;EAAE,OAAO,ENsL1B,GAAO;;AMrL1B;mBACmC;EAAE,OAAO,EN0C1B,GAAO;;AMzCzB,iBAAiC;EAAE,OAAO,ENiS1B,GAAO;;AMhSvB;;eAE+B;EAAE,OAAO,EN9I1B,GAAO;;AM+IrB,kBAAkC;EAAE,OAAO,ENgI1B,GAAO;;AM/HxB,kBAAkC;EAAE,OAAO,EN8H1B,GAAO;;AM7HxB,wBAAwC;EAAE,OAAO,EN4S1B,GAAO;;AM3S9B,oBAAoC;EAAE,OAAO,ENoW1B,GAAO;;AMnW1B,gBAAgC;EAAE,OAAO,ENmT1B,GAAO;;AMlTtB,gBAAgC;EAAE,OAAO,ENkI1B,GAAO;;AMjItB,gBAAgC;EAAE,OAAO,ENuV1B,GAAO;;AMtVtB,oBAAoC;EAAE,OAAO,ENwL1B,GAAO;;AMvL1B,2BAA2C;EAAE,OAAO,ENyL1B,GAAO;;AMxLjC,6BAA6C;EAAE,OAAO,ENyD1B,GAAO;;AMxDnC,sBAAsC;EAAE,OAAO,ENuD1B,GAAO;;AMtD5B,gBAAgC;EAAE,OAAO,ENsJ1B,GAAO;;AMrJtB,qBAAqC;EAAE,OAAO,ENtH1B,GAAO;;AMuH3B,mBAAmC;EAAE,OAAO,ENhH1B,GAAO;;AMiHzB,qBAAqC;EAAE,OAAO,ENvH1B,GAAO;;AMwH3B,sBAAsC;EAAE,OAAO,ENvH1B,GAAO;;AMwH5B,kBAAkC;EAAE,OAAO,ENvE1B,GAAO;;AMwExB;eAC+B;EAAE,OAAO,EN2P1B,GAAO;;AM1PrB;oBACoC;EAAE,OAAO,EN+P1B,GAAO;;AM9P1B;mBACmC;EAAE,OAAO,EN4P1B,GAAO;;AM3PzB,mBAAmC;EAAE,OAAO,ENxC1B,GAAO;;AMyCzB,mBAAmC;EAAE,OAAO,ENkG1B,GAAO;;AMjGzB;eAC+B;EAAE,OAAO,EN8U1B,GAAO;;AM7UrB;gBACgC;EAAE,OAAO,ENqB1B,GAAO;;AMpBtB;qBACqC;EAAE,OAAO,EN2R1B,GAAO;;AM1R3B,oBAAoC;EAAE,OAAO,ENpF1B,GAAO;;AMqF1B,qBAAqC;EAAE,OAAO,ENnF1B,GAAO;;AMoF3B;eAC+B;EAAE,OAAO,ENjK1B,GAAO;;AMkKrB,kBAAkC;EAAE,OAAO,ENkO1B,GAAO;;AMjOxB,mBAAmC;EAAE,OAAO,ENkU1B,GAAO;;AMjUzB;oBACoC;EAAE,OAAO,EN1G1B,GAAO;;AM2G1B,sBAAsC;EAAE,OAAO,ENgF1B,GAAO;;AM/E5B,mBAAmC;EAAE,OAAO,ENnD1B,GAAO;;AMoDzB,yBAAyC;EAAE,OAAO,ENzG1B,GAAO;;AM0G/B,uBAAuC;EAAE,OAAO,ENzG1B,GAAO;;AM0G7B,kBAAkC;EAAE,OAAO,ENsU1B,GAAO;;AMrUxB,sBAAsC;EAAE,OAAO,EN+P1B,GAAO;;AM9P5B,mBAAmC;EAAE,OAAO,ENsQ1B,GAAO;;AMrQzB,iBAAiC;EAAE,OAAO,ENvL1B,GAAO;;AMwLvB,iBAAiC;EAAE,OAAO,ENzG1B,GAAO;;AM0GvB,kBAAkC;EAAE,OAAO,ENtF1B,GAAO;;AMuFxB,sBAAsC;EAAE,OAAO,EN3B1B,GAAO;;AM4B5B,qBAAqC;EAAE,OAAO,ENxK1B,GAAO;;AMyK3B,qBAAqC;EAAE,OAAO,ENkC1B,GAAO;;AMjC3B,oBAAoC;EAAE,OAAO,EN3O1B,GAAO;;AM4O1B,iBAAiC;EAAE,OAAO,ENiG1B,GAAO;;AMhGvB,sBAAsC;EAAE,OAAO,EN/C1B,GAAO;;AMgD5B,eAA+B;EAAE,OAAO,ENpM1B,GAAO;;AMqMrB,mBAAmC;EAAE,OAAO,ENe1B,GAAO;;AMdzB,sBAAsC;EAAE,OAAO,ENgJ1B,GAAO;;AM/I5B,4BAA4C;EAAE,OAAO,EN5O1B,GAAO;;AM6OlC,6BAA6C;EAAE,OAAO,EN5O1B,GAAO;;AM6OnC,0BAA0C;EAAE,OAAO,EN5O1B,GAAO;;AM6OhC,4BAA4C;EAAE,OAAO,ENhP1B,GAAO;;AMiPlC,qBAAqC;EAAE,OAAO,EN5O1B,GAAO;;AM6O3B,sBAAsC;EAAE,OAAO,EN5O1B,GAAO;;AM6O5B,mBAAmC;EAAE,OAAO,EN5O1B,GAAO;;AM6OzB,qBAAqC;EAAE,OAAO,ENhP1B,GAAO;;AMiP3B,kBAAkC;EAAE,OAAO,ENlG1B,GAAO;;AMmGxB,iBAAiC;EAAE,OAAO,ENuC1B,GAAO;;AMtCvB,iBAAiC;EAAE,OAAO,ENoP1B,GAAO;;AMnPvB;iBACiC;EAAE,OAAO,ENyF1B,GAAO;;AMxFvB,mBAAmC;EAAE,OAAO,EN9I1B,GAAO;;AM+IzB,qBAAqC;EAAE,OAAO,EN0I1B,GAAO;;AMzI3B,sBAAsC;EAAE,OAAO,EN0I1B,GAAO;;AMzI5B,kBAAkC;EAAE,OAAO,ENgN1B,GAAO;;AM/MxB,iBAAiC;EAAE,OAAO,ENnJ1B,GAAO;;AMoJvB;gBACgC;EAAE,OAAO,ENkJ1B,GAAO;;AMjJtB,qBAAqC;EAAE,OAAO,ENnB1B,GAAO;;AMoB3B,mBAAmC;EAAE,OAAO,ENxC1B,GAAO;;AMyCzB,wBAAwC;EAAE,OAAO,ENvC1B,GAAO;;AMwC9B,kBAAkC;EAAE,OAAO,EN0L1B,GAAO;;AMzLxB,kBAAkC;EAAE,OAAO,ENpC1B,GAAO;;AMqCxB,gBAAgC;EAAE,OAAO,ENoE1B,GAAO;;AMnEtB,kBAAkC;EAAE,OAAO,ENpC1B,GAAO;;AMqCxB,qBAAqC;EAAE,OAAO,ENkB1B,GAAO;;AMjB3B,iBAAiC;EAAE,OAAO,ENrD1B,GAAO;;AMsDvB,yBAAyC;EAAE,OAAO,ENvD1B,GAAO;;AMwD/B,mBAAmC;EAAE,OAAO,ENuO1B,GAAO;;AMtOzB,eAA+B;EAAE,OAAO,ENtJ1B,GAAO;;AMuJrB;oBACoC;EAAE,OAAO,ENqI1B,GAAO;;AMpI1B;;sBAEsC;EAAE,OAAO,ENuM1B,GAAO;;AMtM5B,yBAAyC;EAAE,OAAO,ENkC1B,GAAO;;AMjC/B,eAA+B;EAAE,OAAO,EN5I1B,GAAO;;AM6IrB,oBAAoC;EAAE,OAAO,EN7J1B,GAAO;;AM8J1B;uBACuC;EAAE,OAAO,EN1L1B,GAAO;;AM2L7B,mBAAmC;EAAE,OAAO,EN4G1B,GAAO;;AM3GzB,eAA+B;EAAE,OAAO,ENT1B,GAAO;;AMUrB,sBAAsC;EAAE,OAAO,ENhH1B,GAAO;;AMiH5B,sBAAsC;EAAE,OAAO,EN8M1B,GAAO;;AM7M5B,oBAAoC;EAAE,OAAO,ENyM1B,GAAO;;AMxM1B,iBAAiC;EAAE,OAAO,ENvH1B,GAAO;;AMwHvB,uBAAuC;EAAE,OAAO,ENmG1B,GAAO;;AMlG7B,qBAAqC;EAAE,OAAO,EN8C1B,GAAO;;AM7C3B,2BAA2C;EAAE,OAAO,EN8C1B,GAAO;;AM7CjC,iBAAiC;EAAE,OAAO,ENgJ1B,GAAO;;AM/IvB,qBAAqC;EAAE,OAAO,EN5N1B,GAAO;;AM6N3B,4BAA4C;EAAE,OAAO,ENjF1B,GAAO;;AMkFlC,iBAAiC;EAAE,OAAO,ENoH1B,GAAO;;AMnHvB,iBAAiC;EAAE,OAAO,ENkC1B,GAAO;;AMjCvB,8BAA8C;EAAE,OAAO,ENlM1B,GAAO;;AMmMpC,+BAA+C;EAAE,OAAO,ENlM1B,GAAO;;AMmMrC,4BAA4C;EAAE,OAAO,ENlM1B,GAAO;;AMmMlC,8BAA8C;EAAE,OAAO,ENtM1B,GAAO;;AMuMpC,gBAAgC;EAAE,OAAO,EN/B1B,GAAO;;AMgCtB,eAA+B;EAAE,OAAO,ENjK1B,GAAO;;AMkKrB,iBAAiC;EAAE,OAAO,EN9S1B,GAAO;;AM+SvB,qBAAqC;EAAE,OAAO,ENmP1B,GAAO;;AMlP3B,mBAAmC;EAAE,OAAO,EN9O1B,GAAO;;AM+OzB,qBAAqC;EAAE,OAAO,EN/I1B,GAAO;;AMgJ3B,qBAAqC;EAAE,OAAO,EN/I1B,GAAO;;AMgJ3B,qBAAqC;EAAE,OAAO,EN4G1B,GAAO;;AM3G3B,sBAAsC;EAAE,OAAO,ENsE1B,GAAO;;AMrE5B,iBAAiC;EAAE,OAAO,EN2M1B,GAAO;;AM1MvB,uBAAuC;EAAE,OAAO,EN6B1B,GAAO;;AM5B7B,yBAAyC;EAAE,OAAO,EN6B1B,GAAO;;AM5B/B,mBAAmC;EAAE,OAAO,ENhB1B,GAAO;;AMiBzB,qBAAqC;EAAE,OAAO,ENlB1B,GAAO;;AMmB3B,uBAAuC;EAAE,OAAO,ENvN1B,GAAO;;AMwN7B,wBAAwC;EAAE,OAAO,ENiD1B,GAAO;;AMhD9B,+BAA+C;EAAE,OAAO,EN3I1B,GAAO;;AM4IrC,uBAAuC;EAAE,OAAO,ENkH1B,GAAO;;AMjH7B,kBAAkC;EAAE,OAAO,EN1L1B,GAAO;;AM2LxB;8BAC8C;EAAE,OAAO,ENjP1B,GAAO;;AMkPpC;4BAC4C;EAAE,OAAO,ENhP1B,GAAO;;AMiPlC;+BAC+C;EAAE,OAAO,ENnP1B,GAAO;;AMoPrC;cAC8B;EAAE,OAAO,EN7J1B,GAAO;;AM8JpB,cAA8B;EAAE,OAAO,EN/F1B,GAAO;;AMgGpB;cAC8B;EAAE,OAAO,EN4N1B,GAAO;;AM3NpB;cAC8B;EAAE,OAAO,ENvD1B,GAAO;;AMwDpB;;;cAG8B;EAAE,OAAO,ENrD1B,GAAO;;AMsDpB;;cAE8B;EAAE,OAAO,EN8E1B,GAAO;;AM7EpB;cAC8B;EAAE,OAAO,ENtD1B,GAAO;;AMuDpB;cAC8B;EAAE,OAAO,ENzR1B,GAAO;;AM0RpB,eAA+B;EAAE,OAAO,ENzJ1B,GAAO;;AM0JrB,oBAAoC;EAAE,OAAO,EN7I1B,GAAO;;AM8I1B,yBAAyC;EAAE,OAAO,EN2G1B,GAAO;;AM1G/B,0BAA0C;EAAE,OAAO,EN2G1B,GAAO;;AM1GhC,0BAA0C;EAAE,OAAO,EN2G1B,GAAO;;AM1GhC,2BAA2C;EAAE,OAAO,EN2G1B,GAAO;;AM1GjC,2BAA2C;EAAE,OAAO,EN8G1B,GAAO;;AM7GjC,4BAA4C;EAAE,OAAO,EN8G1B,GAAO;;AM7GlC,oBAAoC;EAAE,OAAO,ENgK1B,GAAO;;AM/J1B,sBAAsC;EAAE,OAAO,EN4J1B,GAAO;;AM3J5B,yBAAyC;EAAE,OAAO,ENwO1B,GAAO;;AMvO/B,kBAAkC;EAAE,OAAO,ENqO1B,GAAO;;AMpOxB,eAA+B;EAAE,OAAO,EN+N1B,GAAO;;AM9NrB,sBAAsC;EAAE,OAAO,EN+N1B,GAAO;;AM9N5B,uBAAuC;EAAE,OAAO,ENmO1B,GAAO;;AMlO7B,kBAAkC;EAAE,OAAO,ENxM1B,GAAO;;AMyMxB,yBAAyC;EAAE,OAAO,EN+G1B,GAAO;;AM9G/B,oBAAoC;EAAE,OAAO,ENnF1B,GAAO;;AMoF1B,iBAAiC;EAAE,OAAO,EN/I1B,GAAO;;AMgJvB,cAA8B;EAAE,OAAO,ENhX1B,GAAO;;AMiXpB,oBAAoC;EAAE,OAAO,ENxT1B,GAAO;;AMyT1B,2BAA2C;EAAE,OAAO,ENxT1B,GAAO;;AMyTjC,iBAAiC;EAAE,OAAO,ENyK1B,GAAO;;AMxKvB,wBAAwC;EAAE,OAAO,ENyK1B,GAAO;;AMxK9B,0BAA0C;EAAE,OAAO,ENtD1B,GAAO;;AMuDhC,wBAAwC;EAAE,OAAO,ENpD1B,GAAO;;AMqD9B,0BAA0C;EAAE,OAAO,ENvD1B,GAAO;;AMwDhC,2BAA2C;EAAE,OAAO,ENvD1B,GAAO;;AMwDjC,gBAAgC;EAAE,OAAO,ENxW1B,GAAO;;AMyWtB,kBAAkC;EAAE,OAAO,EN0M1B,GAAO;;AMzMxB,kBAAkC;EAAE,OAAO,ENpX1B,GAAO;;AMqXxB,gBAAgC;EAAE,OAAO,ENpE1B,GAAO;;AMqEtB,mBAAmC;EAAE,OAAO,EN1N1B,GAAO;;AM2NzB,gBAAgC;EAAE,OAAO,ENqE1B,GAAO;;AMpEtB,qBAAqC;EAAE,OAAO,ENtJ1B,GAAO;;AMuJ3B,iBAAiC;EAAE,OAAO,ENuJ1B,GAAO;;AMtJvB,iBAAiC;EAAE,OAAO,EN/L1B,GAAO;;AMgMvB,eAA+B;EAAE,OAAO,EN1D1B,GAAO;;AM2DrB;mBACmC;EAAE,OAAO,ENnI1B,GAAO;;AMoIzB,gBAAgC;EAAE,OAAO,EN2G1B,GAAO;;AM1GtB,iBAAiC;EAAE,OAAO,ENxC1B,GAAO;;AMyCvB,kBAAkC;EAAE,OAAO,ENrX1B,GAAO;;AMsXxB,cAA8B;EAAE,OAAO,ENpU1B,GAAO;;AMqUpB,aAA6B;EAAE,OAAO,ENgL1B,GAAO;;AM/KnB,gBAAgC;EAAE,OAAO,ENqL1B,GAAO;;AMpLtB,iBAAiC;EAAE,OAAO,ENa1B,GAAO;;AMZvB,oBAAoC;EAAE,OAAO,ENrC1B,GAAO;;AMsC1B,yBAAyC;EAAE,OAAO,EN8E1B,GAAO;;AM7E/B,+BAA+C;EAAE,OAAO,ENtX1B,GAAO;;AMuXrC,8BAA8C;EAAE,OAAO,ENxX1B,GAAO;;AMyXpC;8BAC8C;EAAE,OAAO,EN3T1B,GAAO;;AM4TpC,uBAAuC;EAAE,OAAO,ENjP1B,GAAO;;AMkP7B,qBAAqC;EAAE,OAAO,EN+K1B,GAAO;;AM9K3B,uBAAuC;EAAE,OAAO,ENmK1B,GAAO;;AMlK7B;cAC8B;EAAE,OAAO,ENoI1B,GAAO;;AMnIpB,wBAAwC;EAAE,OAAO,ENjB1B,GAAO;;AMkB9B,wBAAwC;EAAE,OAAO,EN6D1B,GAAO;;AM5D9B,gBAAgC;EAAE,OAAO,EN2C1B,GAAO;;AM1CtB,0BAA0C;EAAE,OAAO,EN7O1B,GAAO;;AM8OhC,oBAAoC;EAAE,OAAO,EN2K1B,GAAO;;AM1K1B,iBAAiC;EAAE,OAAO,ENvD1B,GAAO;;AMwDvB;;qBAEqC;EAAE,OAAO,ENsI1B,GAAO;;AMrI3B;yBACyC;EAAE,OAAO,ENjK1B,GAAO;;AMkK/B,gBAAgC;EAAE,OAAO,ENwK1B,GAAO;;AMvKtB,iBAAiC;EAAE,OAAO,ENvK1B,GAAO;;AMwKvB,iBAAiC;EAAE,OAAO,ENhB1B,GAAO;;AMiBvB,wBAAwC;EAAE,OAAO,ENhB1B,GAAO;;AMiB9B,6BAA6C;EAAE,OAAO,ENsE1B,GAAO;;AMrEnC,sBAAsC;EAAE,OAAO,ENoE1B,GAAO;;AMnE5B,oBAAoC;EAAE,OAAO,EN7Q1B,GAAO;;AM8Q1B,eAA+B;EAAE,OAAO,EN1Q1B,GAAO;;AM2QrB,qBAAqC;EAAE,OAAO,ENjD1B,GAAO;;AMkD3B,yBAAyC;EAAE,OAAO,ENjD1B,GAAO;;AMkD/B,iBAAiC;EAAE,OAAO,ENvQ1B,GAAO;;AMwQvB,iBAAiC;EAAE,OAAO,EN9I1B,GAAO;;AM+IvB,mBAAmC;EAAE,OAAO,ENzI1B,GAAO;;AM0IzB,cAA8B;EAAE,OAAO,EN9O1B,GAAO;;AM+OpB,mBAAmC;EAAE,OAAO,EN3W1B,GAAO;;AM4WzB,gBAAgC;EAAE,OAAO,EN9T1B,GAAO;;AM+TtB,cAA8B;EAAE,OAAO,ENnE1B,GAAO;;AMoEpB,gBAAgC;EAAE,OAAO,ENoC1B,GAAO;;AMnCtB,eAA+B;EAAE,OAAO,ENjS1B,GAAO;;AMkSrB,gBAAgC;EAAE,OAAO,ENjS1B,GAAO;;AMkStB,kBAAkC;EAAE,OAAO,ENtY1B,GAAO;;AMuYxB,yBAAyC;EAAE,OAAO,ENtY1B,GAAO;;AMuY/B,gBAAgC;EAAE,OAAO,EN2C1B,GAAO;;AM1CtB,uBAAuC;EAAE,OAAO,EN2C1B,GAAO;;AM1C7B,kBAAkC;EAAE,OAAO,ENvC1B,GAAO;;AMwCxB;cAC8B;EAAE,OAAO,EN3W1B,GAAO;;AM4WpB;eAC+B;EAAE,OAAO,EN2D1B,GAAO;;AM1DrB,eAA+B;EAAE,OAAO,ENuF1B,GAAO;;AMtFrB,kBAAkC;EAAE,OAAO,ENwB1B,GAAO;;AMvBxB,qBAAqC;EAAE,OAAO,ENpS1B,GAAO;;AMqS3B,qBAAqC;EAAE,OAAO,ENkB1B,GAAO;;AMjB3B,mBAAmC;EAAE,OAAO,EN1S1B,GAAO;;AM2SzB,qBAAqC;EAAE,OAAO,ENxP1B,GAAO;;AMyP3B,sBAAsC;EAAE,OAAO,ENjP1B,GAAO;;AMkP5B,uBAAuC;EAAE,OAAO,EN9P1B,GAAO;;AM+P7B,4BAA4C;EAAE,OAAO,ENxP1B,GAAO;;AMyPlC;;uBAEuC;EAAE,OAAO,ENjQ1B,GAAO;;AMkQ7B;yBACyC;EAAE,OAAO,ENvQ1B,GAAO;;AMwQ/B;uBACuC;EAAE,OAAO,ENxQ1B,GAAO;;AMyQ7B;uBACuC;EAAE,OAAO,EN7P1B,GAAO;;AM8P7B,sBAAsC;EAAE,OAAO,EN1Q1B,GAAO;;AM2Q5B,eAA+B;EAAE,OAAO,ENsG1B,GAAO;;AMrGrB,kBAAkC;EAAE,OAAO,ENlV1B,GAAO;;AMmVxB,mBAAmC;EAAE,OAAO,ENnL1B,GAAO;;AMoLzB;;;;oBAIoC;EAAE,OAAO,ENxK1B,GAAO;;AMyK1B,yBAAyC;EAAE,OAAO,ENpW1B,GAAO;;AMqW/B;gBACgC;EAAE,OAAO,EN1E1B,GAAO;;AM2EtB;iBACiC;EAAE,OAAO,ENpT1B,GAAO;;AMqTvB,qBAAqC;EAAE,OAAO,EN1O1B,GAAO;;AM2O3B,cAA8B;EAAE,OAAO,EN5O1B,GAAO;;AM6OpB,sBAAsC;EAAE,OAAO,EN7N1B,GAAO;;AM8N5B,wBAAwC;EAAE,OAAO,ENwB1B,GAAO;;AMvB9B,aAA6B;EAAE,OAAO,ENzF1B,GAAO;;AM0FnB;iBACiC;EAAE,OAAO,EN2F1B,GAAO;;AM1FvB;sBACsC;EAAE,OAAO,EN9H1B,GAAO;;AM+H5B;wBACwC;EAAE,OAAO,EN/H1B,GAAO;;AMgI9B,kBAAkC;EAAE,OAAO,EN3N1B,GAAO;;AM4NxB;sBACsC;EAAE,OAAO,ENrX1B,GAAO;;AMsX5B,iBAAiC;EAAE,OAAO,ENnO1B,GAAO;;AMoOvB,oBAAoC;EAAE,OAAO,ENlI1B,GAAO;;AMmI1B,kBAAkC;EAAE,OAAO,EN1C1B,GAAO;;AM2CxB,oBAAoC;EAAE,OAAO,EN7D1B,GAAO;;AM8D1B,2BAA2C;EAAE,OAAO,EN7D1B,GAAO;;AM8DjC,eAA+B;EAAE,OAAO,ENpb1B,GAAO;;AMqbrB;mBACmC;EAAE,OAAO,ENzQ1B,GAAO;;AM0QzB,cAA8B;EAAE,OAAO,ENsC1B,GAAO;;AMrCpB,qBAAqC;EAAE,OAAO,EN/b1B,GAAO;;AMgc3B,eAA+B;EAAE,OAAO,ENrH1B,GAAO;;AMsHrB,qBAAqC;EAAE,OAAO,ENlD1B,GAAO;;AMmD3B,iBAAiC;EAAE,OAAO,ENsC1B,GAAO;;AMrCvB,eAA+B;EAAE,OAAO,ENiF1B,GAAO;;AMhFrB,sBAAsC;EAAE,OAAO,ENvJ1B,GAAO;;AMwJ5B,eAA+B;EAAE,OAAO,ENuE1B,GAAO;;AMtErB,qBAAqC;EAAE,OAAO,ENjb1B,GAAO;;AMkb3B,iBAAiC;EAAE,OAAO,EN9I1B,GAAO;;AM+IvB,wBAAwC;EAAE,OAAO,ENhQ1B,GAAO;;AMiQ9B,kBAAkC;EAAE,OAAO,EN9Z1B,GAAO;;AM+ZxB,wBAAwC;EAAE,OAAO,ENla1B,GAAO;;AMma9B,sBAAsC;EAAE,OAAO,ENpa1B,GAAO;;AMqa5B,kBAAkC;EAAE,OAAO,ENta1B,GAAO;;AMuaxB,oBAAoC;EAAE,OAAO,ENpa1B,GAAO;;AMqa1B,oBAAoC;EAAE,OAAO,ENpa1B,GAAO;;AMqa1B,qBAAqC;EAAE,OAAO,ENld1B,GAAO;;AMmd3B,uBAAuC;EAAE,OAAO,ENld1B,GAAO;;AMmd7B,gBAAgC;EAAE,OAAO,ENY1B,GAAO;;AMXtB,oBAAoC;EAAE,OAAO,EN3X1B,GAAO;;AM4X1B,aAA6B;EAAE,OAAO,ENre1B,GAAO;;AMsenB,qBAAqC;EAAE,OAAO,ENjV1B,GAAO;;AMkV3B,sBAAsC;EAAE,OAAO,ENpK1B,GAAO;;AMqK5B,wBAAwC;EAAE,OAAO,ENrd1B,GAAO;;AMsd9B,qBAAqC;EAAE,OAAO,EN3f1B,GAAO;;AM4f3B,oBAAoC;EAAE,OAAO,ENvJ1B,GAAO;;AMwJ1B,qBAAqC;EAAE,OAAO,EN5N1B,GAAO;;AM6N3B,iBAAiC;EAAE,OAAO,EN1O1B,GAAO;;AM2OvB,wBAAwC;EAAE,OAAO,EN1O1B,GAAO;;AM2O9B,qBAAqC;EAAE,OAAO,ENN1B,GAAO;;AMO3B,oBAAoC;EAAE,OAAO,ENN1B,GAAO;;AMO1B,kBAAkC;EAAE,OAAO,EN/d1B,GAAO;;AMgexB,cAA8B;EAAE,OAAO,EN7c1B,GAAO;;AM8cpB,kBAAkC;EAAE,OAAO,EN1P1B,GAAO;;AM2PxB,oBAAoC;EAAE,OAAO,ENhhB1B,GAAO;;AMihB1B,aAA6B;EAAE,OAAO,EN7b1B,GAAO;;AM8bnB;;cAE8B;EAAE,OAAO,ENxQ1B,GAAO;;AMyQpB,mBAAmC;EAAE,OAAO,EN7M1B,GAAO;;AM8MzB,qBAAqC;EAAE,OAAO,ENpd1B,GAAO;;AMqd3B,yBAAyC;EAAE,OAAO,ENnZ1B,GAAO;;AMoZ/B,mBAAmC;EAAE,OAAO,ENxY1B,GAAO;;AMyYzB,mBAAmC;EAAE,OAAO,EN1T1B,GAAO;;AM2TzB,kBAAkC;EAAE,OAAO,ENxP1B,GAAO;;AMyPxB,iBAAiC;EAAE,OAAO,ENrH1B,GAAO;;AMsHvB,uBAAuC;EAAE,OAAO,ENzG1B,GAAO;;AM0G7B,sBAAsC;EAAE,OAAO,ENrG1B,GAAO;;AMsG5B,mBAAmC;EAAE,OAAO,ENpG1B,GAAO;;AMqGzB,oBAAoC;EAAE,OAAO,EN5c1B,GAAO;;AM6c1B,0BAA0C;EAAE,OAAO,EN9c1B,GAAO;;AM+chC,kBAAkC;EAAE,OAAO,EN3Y1B,GAAO;;AM4YxB,eAA+B;EAAE,OAAO,ENhH1B,GAAO;;AMiHrB,sBAAsC;EAAE,OAAO,ENI1B,GAAO;;AMH5B,qBAAqC;EAAE,OAAO,EN5M1B,GAAO;;AM6M3B,sBAAsC;EAAE,OAAO,ENpE1B,GAAO;;AMqE5B,oBAAoC;EAAE,OAAO,ENhS1B,GAAO;;AMiS1B,gBAAgC;EAAE,OAAO,ENG1B,GAAO;;AMFtB,eAA+B;EAAE,OAAO,ENtO1B,GAAO;;AMuOrB,kBAAkC;EAAE,OAAO,EN7N1B,GAAO;;AM8NxB,sBAAsC;EAAE,OAAO,ENhC1B,GAAO;;AMiC5B,0BAA0C;EAAE,OAAO,ENhC1B,GAAO;;AMiChC,uBAAuC;EAAE,OAAO,END1B,GAAO;;AME7B,sBAAsC;EAAE,OAAO,EN1O1B,GAAO;;AM2O5B,qBAAqC;EAAE,OAAO,ENF1B,GAAO;;AMG3B,sBAAsC;EAAE,OAAO,EN3O1B,GAAO;;AM4O5B,wBAAwC;EAAE,OAAO,EN1O1B,GAAO;;AM2O9B,wBAAwC;EAAE,OAAO,EN5O1B,GAAO;;AM6O9B,iBAAiC;EAAE,OAAO,ENvN1B,GAAO;;AMwNvB,4BAA4C;EAAE,OAAO,EN9X1B,GAAO;;AM+XlC,sBAAsC;EAAE,OAAO,ENhM1B,GAAO;;AMiM5B,mBAAmC;EAAE,OAAO,ENI1B,GAAO;;AMHzB,iBAAiC;EAAE,OAAO,EN7I1B,GAAO;;AM8IvB,oBAAoC;EAAE,OAAO,ENjB1B,GAAO;;AMkB1B,qBAAqC;EAAE,OAAO,ENhB1B,GAAO;;AMiB3B;cAC8B;EAAE,OAAO,ENphB1B,GAAO;;AMqhBpB,kBAAkC;EAAE,OAAO,ENd1B,GAAO;;AMexB,gBAAgC;EAAE,OAAO,ENnD1B,GAAO;;AMoDtB,iBAAiC;EAAE,OAAO,ENvF1B,GAAO;;AMwFvB,iBAAiC;EAAE,OAAO,ENrP1B,GAAO", +"sources": ["../scss/_path.scss","../scss/_core.scss","../scss/_larger.scss","../scss/_fixed-width.scss","../scss/_list.scss","../scss/_variables.scss","../scss/_bordered-pulled.scss","../scss/_animated.scss","../scss/_rotated-flipped.scss","../scss/_mixins.scss","../scss/_stacked.scss","../scss/_icons.scss"], +"names": [], +"file": "font-awesome.css" +} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.min.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.min.css new file mode 100755 index 0000000000000..540440ce89f2a --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.min.css @@ -0,0 +1,4 @@ +/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url('../fonts/fontawesome-webfont.eot?v=4.7.0');src:url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'),url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'),url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'),url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'),url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');font-weight:normal;font-style:normal}.fa{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571429em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14285714em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14285714em;width:2.14285714em;top:.14285714em;text-align:center}.fa-li.fa-lg{left:-1.85714286em}.fa-border{padding:.2em .25em .15em;border:solid .08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left{margin-right:.3em}.fa.fa-pull-right{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left{margin-right:.3em}.fa.pull-right{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:"\f000"}.fa-music:before{content:"\f001"}.fa-search:before{content:"\f002"}.fa-envelope-o:before{content:"\f003"}.fa-heart:before{content:"\f004"}.fa-star:before{content:"\f005"}.fa-star-o:before{content:"\f006"}.fa-user:before{content:"\f007"}.fa-film:before{content:"\f008"}.fa-th-large:before{content:"\f009"}.fa-th:before{content:"\f00a"}.fa-th-list:before{content:"\f00b"}.fa-check:before{content:"\f00c"}.fa-remove:before,.fa-close:before,.fa-times:before{content:"\f00d"}.fa-search-plus:before{content:"\f00e"}.fa-search-minus:before{content:"\f010"}.fa-power-off:before{content:"\f011"}.fa-signal:before{content:"\f012"}.fa-gear:before,.fa-cog:before{content:"\f013"}.fa-trash-o:before{content:"\f014"}.fa-home:before{content:"\f015"}.fa-file-o:before{content:"\f016"}.fa-clock-o:before{content:"\f017"}.fa-road:before{content:"\f018"}.fa-download:before{content:"\f019"}.fa-arrow-circle-o-down:before{content:"\f01a"}.fa-arrow-circle-o-up:before{content:"\f01b"}.fa-inbox:before{content:"\f01c"}.fa-play-circle-o:before{content:"\f01d"}.fa-rotate-right:before,.fa-repeat:before{content:"\f01e"}.fa-refresh:before{content:"\f021"}.fa-list-alt:before{content:"\f022"}.fa-lock:before{content:"\f023"}.fa-flag:before{content:"\f024"}.fa-headphones:before{content:"\f025"}.fa-volume-off:before{content:"\f026"}.fa-volume-down:before{content:"\f027"}.fa-volume-up:before{content:"\f028"}.fa-qrcode:before{content:"\f029"}.fa-barcode:before{content:"\f02a"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-book:before{content:"\f02d"}.fa-bookmark:before{content:"\f02e"}.fa-print:before{content:"\f02f"}.fa-camera:before{content:"\f030"}.fa-font:before{content:"\f031"}.fa-bold:before{content:"\f032"}.fa-italic:before{content:"\f033"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-align-left:before{content:"\f036"}.fa-align-center:before{content:"\f037"}.fa-align-right:before{content:"\f038"}.fa-align-justify:before{content:"\f039"}.fa-list:before{content:"\f03a"}.fa-dedent:before,.fa-outdent:before{content:"\f03b"}.fa-indent:before{content:"\f03c"}.fa-video-camera:before{content:"\f03d"}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:"\f03e"}.fa-pencil:before{content:"\f040"}.fa-map-marker:before{content:"\f041"}.fa-adjust:before{content:"\f042"}.fa-tint:before{content:"\f043"}.fa-edit:before,.fa-pencil-square-o:before{content:"\f044"}.fa-share-square-o:before{content:"\f045"}.fa-check-square-o:before{content:"\f046"}.fa-arrows:before{content:"\f047"}.fa-step-backward:before{content:"\f048"}.fa-fast-backward:before{content:"\f049"}.fa-backward:before{content:"\f04a"}.fa-play:before{content:"\f04b"}.fa-pause:before{content:"\f04c"}.fa-stop:before{content:"\f04d"}.fa-forward:before{content:"\f04e"}.fa-fast-forward:before{content:"\f050"}.fa-step-forward:before{content:"\f051"}.fa-eject:before{content:"\f052"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-plus-circle:before{content:"\f055"}.fa-minus-circle:before{content:"\f056"}.fa-times-circle:before{content:"\f057"}.fa-check-circle:before{content:"\f058"}.fa-question-circle:before{content:"\f059"}.fa-info-circle:before{content:"\f05a"}.fa-crosshairs:before{content:"\f05b"}.fa-times-circle-o:before{content:"\f05c"}.fa-check-circle-o:before{content:"\f05d"}.fa-ban:before{content:"\f05e"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrow-down:before{content:"\f063"}.fa-mail-forward:before,.fa-share:before{content:"\f064"}.fa-expand:before{content:"\f065"}.fa-compress:before{content:"\f066"}.fa-plus:before{content:"\f067"}.fa-minus:before{content:"\f068"}.fa-asterisk:before{content:"\f069"}.fa-exclamation-circle:before{content:"\f06a"}.fa-gift:before{content:"\f06b"}.fa-leaf:before{content:"\f06c"}.fa-fire:before{content:"\f06d"}.fa-eye:before{content:"\f06e"}.fa-eye-slash:before{content:"\f070"}.fa-warning:before,.fa-exclamation-triangle:before{content:"\f071"}.fa-plane:before{content:"\f072"}.fa-calendar:before{content:"\f073"}.fa-random:before{content:"\f074"}.fa-comment:before{content:"\f075"}.fa-magnet:before{content:"\f076"}.fa-chevron-up:before{content:"\f077"}.fa-chevron-down:before{content:"\f078"}.fa-retweet:before{content:"\f079"}.fa-shopping-cart:before{content:"\f07a"}.fa-folder:before{content:"\f07b"}.fa-folder-open:before{content:"\f07c"}.fa-arrows-v:before{content:"\f07d"}.fa-arrows-h:before{content:"\f07e"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:"\f080"}.fa-twitter-square:before{content:"\f081"}.fa-facebook-square:before{content:"\f082"}.fa-camera-retro:before{content:"\f083"}.fa-key:before{content:"\f084"}.fa-gears:before,.fa-cogs:before{content:"\f085"}.fa-comments:before{content:"\f086"}.fa-thumbs-o-up:before{content:"\f087"}.fa-thumbs-o-down:before{content:"\f088"}.fa-star-half:before{content:"\f089"}.fa-heart-o:before{content:"\f08a"}.fa-sign-out:before{content:"\f08b"}.fa-linkedin-square:before{content:"\f08c"}.fa-thumb-tack:before{content:"\f08d"}.fa-external-link:before{content:"\f08e"}.fa-sign-in:before{content:"\f090"}.fa-trophy:before{content:"\f091"}.fa-github-square:before{content:"\f092"}.fa-upload:before{content:"\f093"}.fa-lemon-o:before{content:"\f094"}.fa-phone:before{content:"\f095"}.fa-square-o:before{content:"\f096"}.fa-bookmark-o:before{content:"\f097"}.fa-phone-square:before{content:"\f098"}.fa-twitter:before{content:"\f099"}.fa-facebook-f:before,.fa-facebook:before{content:"\f09a"}.fa-github:before{content:"\f09b"}.fa-unlock:before{content:"\f09c"}.fa-credit-card:before{content:"\f09d"}.fa-feed:before,.fa-rss:before{content:"\f09e"}.fa-hdd-o:before{content:"\f0a0"}.fa-bullhorn:before{content:"\f0a1"}.fa-bell:before{content:"\f0f3"}.fa-certificate:before{content:"\f0a3"}.fa-hand-o-right:before{content:"\f0a4"}.fa-hand-o-left:before{content:"\f0a5"}.fa-hand-o-up:before{content:"\f0a6"}.fa-hand-o-down:before{content:"\f0a7"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-globe:before{content:"\f0ac"}.fa-wrench:before{content:"\f0ad"}.fa-tasks:before{content:"\f0ae"}.fa-filter:before{content:"\f0b0"}.fa-briefcase:before{content:"\f0b1"}.fa-arrows-alt:before{content:"\f0b2"}.fa-group:before,.fa-users:before{content:"\f0c0"}.fa-chain:before,.fa-link:before{content:"\f0c1"}.fa-cloud:before{content:"\f0c2"}.fa-flask:before{content:"\f0c3"}.fa-cut:before,.fa-scissors:before{content:"\f0c4"}.fa-copy:before,.fa-files-o:before{content:"\f0c5"}.fa-paperclip:before{content:"\f0c6"}.fa-save:before,.fa-floppy-o:before{content:"\f0c7"}.fa-square:before{content:"\f0c8"}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:"\f0c9"}.fa-list-ul:before{content:"\f0ca"}.fa-list-ol:before{content:"\f0cb"}.fa-strikethrough:before{content:"\f0cc"}.fa-underline:before{content:"\f0cd"}.fa-table:before{content:"\f0ce"}.fa-magic:before{content:"\f0d0"}.fa-truck:before{content:"\f0d1"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-square:before{content:"\f0d3"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-plus:before{content:"\f0d5"}.fa-money:before{content:"\f0d6"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-up:before{content:"\f0d8"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-columns:before{content:"\f0db"}.fa-unsorted:before,.fa-sort:before{content:"\f0dc"}.fa-sort-down:before,.fa-sort-desc:before{content:"\f0dd"}.fa-sort-up:before,.fa-sort-asc:before{content:"\f0de"}.fa-envelope:before{content:"\f0e0"}.fa-linkedin:before{content:"\f0e1"}.fa-rotate-left:before,.fa-undo:before{content:"\f0e2"}.fa-legal:before,.fa-gavel:before{content:"\f0e3"}.fa-dashboard:before,.fa-tachometer:before{content:"\f0e4"}.fa-comment-o:before{content:"\f0e5"}.fa-comments-o:before{content:"\f0e6"}.fa-flash:before,.fa-bolt:before{content:"\f0e7"}.fa-sitemap:before{content:"\f0e8"}.fa-umbrella:before{content:"\f0e9"}.fa-paste:before,.fa-clipboard:before{content:"\f0ea"}.fa-lightbulb-o:before{content:"\f0eb"}.fa-exchange:before{content:"\f0ec"}.fa-cloud-download:before{content:"\f0ed"}.fa-cloud-upload:before{content:"\f0ee"}.fa-user-md:before{content:"\f0f0"}.fa-stethoscope:before{content:"\f0f1"}.fa-suitcase:before{content:"\f0f2"}.fa-bell-o:before{content:"\f0a2"}.fa-coffee:before{content:"\f0f4"}.fa-cutlery:before{content:"\f0f5"}.fa-file-text-o:before{content:"\f0f6"}.fa-building-o:before{content:"\f0f7"}.fa-hospital-o:before{content:"\f0f8"}.fa-ambulance:before{content:"\f0f9"}.fa-medkit:before{content:"\f0fa"}.fa-fighter-jet:before{content:"\f0fb"}.fa-beer:before{content:"\f0fc"}.fa-h-square:before{content:"\f0fd"}.fa-plus-square:before{content:"\f0fe"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angle-down:before{content:"\f107"}.fa-desktop:before{content:"\f108"}.fa-laptop:before{content:"\f109"}.fa-tablet:before{content:"\f10a"}.fa-mobile-phone:before,.fa-mobile:before{content:"\f10b"}.fa-circle-o:before{content:"\f10c"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-spinner:before{content:"\f110"}.fa-circle:before{content:"\f111"}.fa-mail-reply:before,.fa-reply:before{content:"\f112"}.fa-github-alt:before{content:"\f113"}.fa-folder-o:before{content:"\f114"}.fa-folder-open-o:before{content:"\f115"}.fa-smile-o:before{content:"\f118"}.fa-frown-o:before{content:"\f119"}.fa-meh-o:before{content:"\f11a"}.fa-gamepad:before{content:"\f11b"}.fa-keyboard-o:before{content:"\f11c"}.fa-flag-o:before{content:"\f11d"}.fa-flag-checkered:before{content:"\f11e"}.fa-terminal:before{content:"\f120"}.fa-code:before{content:"\f121"}.fa-mail-reply-all:before,.fa-reply-all:before{content:"\f122"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:"\f123"}.fa-location-arrow:before{content:"\f124"}.fa-crop:before{content:"\f125"}.fa-code-fork:before{content:"\f126"}.fa-unlink:before,.fa-chain-broken:before{content:"\f127"}.fa-question:before{content:"\f128"}.fa-info:before{content:"\f129"}.fa-exclamation:before{content:"\f12a"}.fa-superscript:before{content:"\f12b"}.fa-subscript:before{content:"\f12c"}.fa-eraser:before{content:"\f12d"}.fa-puzzle-piece:before{content:"\f12e"}.fa-microphone:before{content:"\f130"}.fa-microphone-slash:before{content:"\f131"}.fa-shield:before{content:"\f132"}.fa-calendar-o:before{content:"\f133"}.fa-fire-extinguisher:before{content:"\f134"}.fa-rocket:before{content:"\f135"}.fa-maxcdn:before{content:"\f136"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-html5:before{content:"\f13b"}.fa-css3:before{content:"\f13c"}.fa-anchor:before{content:"\f13d"}.fa-unlock-alt:before{content:"\f13e"}.fa-bullseye:before{content:"\f140"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-rss-square:before{content:"\f143"}.fa-play-circle:before{content:"\f144"}.fa-ticket:before{content:"\f145"}.fa-minus-square:before{content:"\f146"}.fa-minus-square-o:before{content:"\f147"}.fa-level-up:before{content:"\f148"}.fa-level-down:before{content:"\f149"}.fa-check-square:before{content:"\f14a"}.fa-pencil-square:before{content:"\f14b"}.fa-external-link-square:before{content:"\f14c"}.fa-share-square:before{content:"\f14d"}.fa-compass:before{content:"\f14e"}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:"\f150"}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:"\f151"}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:"\f152"}.fa-euro:before,.fa-eur:before{content:"\f153"}.fa-gbp:before{content:"\f154"}.fa-dollar:before,.fa-usd:before{content:"\f155"}.fa-rupee:before,.fa-inr:before{content:"\f156"}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:"\f157"}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:"\f158"}.fa-won:before,.fa-krw:before{content:"\f159"}.fa-bitcoin:before,.fa-btc:before{content:"\f15a"}.fa-file:before{content:"\f15b"}.fa-file-text:before{content:"\f15c"}.fa-sort-alpha-asc:before{content:"\f15d"}.fa-sort-alpha-desc:before{content:"\f15e"}.fa-sort-amount-asc:before{content:"\f160"}.fa-sort-amount-desc:before{content:"\f161"}.fa-sort-numeric-asc:before{content:"\f162"}.fa-sort-numeric-desc:before{content:"\f163"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbs-down:before{content:"\f165"}.fa-youtube-square:before{content:"\f166"}.fa-youtube:before{content:"\f167"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-youtube-play:before{content:"\f16a"}.fa-dropbox:before{content:"\f16b"}.fa-stack-overflow:before{content:"\f16c"}.fa-instagram:before{content:"\f16d"}.fa-flickr:before{content:"\f16e"}.fa-adn:before{content:"\f170"}.fa-bitbucket:before{content:"\f171"}.fa-bitbucket-square:before{content:"\f172"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-long-arrow-down:before{content:"\f175"}.fa-long-arrow-up:before{content:"\f176"}.fa-long-arrow-left:before{content:"\f177"}.fa-long-arrow-right:before{content:"\f178"}.fa-apple:before{content:"\f179"}.fa-windows:before{content:"\f17a"}.fa-android:before{content:"\f17b"}.fa-linux:before{content:"\f17c"}.fa-dribbble:before{content:"\f17d"}.fa-skype:before{content:"\f17e"}.fa-foursquare:before{content:"\f180"}.fa-trello:before{content:"\f181"}.fa-female:before{content:"\f182"}.fa-male:before{content:"\f183"}.fa-gittip:before,.fa-gratipay:before{content:"\f184"}.fa-sun-o:before{content:"\f185"}.fa-moon-o:before{content:"\f186"}.fa-archive:before{content:"\f187"}.fa-bug:before{content:"\f188"}.fa-vk:before{content:"\f189"}.fa-weibo:before{content:"\f18a"}.fa-renren:before{content:"\f18b"}.fa-pagelines:before{content:"\f18c"}.fa-stack-exchange:before{content:"\f18d"}.fa-arrow-circle-o-right:before{content:"\f18e"}.fa-arrow-circle-o-left:before{content:"\f190"}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:"\f191"}.fa-dot-circle-o:before{content:"\f192"}.fa-wheelchair:before{content:"\f193"}.fa-vimeo-square:before{content:"\f194"}.fa-turkish-lira:before,.fa-try:before{content:"\f195"}.fa-plus-square-o:before{content:"\f196"}.fa-space-shuttle:before{content:"\f197"}.fa-slack:before{content:"\f198"}.fa-envelope-square:before{content:"\f199"}.fa-wordpress:before{content:"\f19a"}.fa-openid:before{content:"\f19b"}.fa-institution:before,.fa-bank:before,.fa-university:before{content:"\f19c"}.fa-mortar-board:before,.fa-graduation-cap:before{content:"\f19d"}.fa-yahoo:before{content:"\f19e"}.fa-google:before{content:"\f1a0"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-square:before{content:"\f1a2"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-stumbleupon:before{content:"\f1a4"}.fa-delicious:before{content:"\f1a5"}.fa-digg:before{content:"\f1a6"}.fa-pied-piper-pp:before{content:"\f1a7"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-drupal:before{content:"\f1a9"}.fa-joomla:before{content:"\f1aa"}.fa-language:before{content:"\f1ab"}.fa-fax:before{content:"\f1ac"}.fa-building:before{content:"\f1ad"}.fa-child:before{content:"\f1ae"}.fa-paw:before{content:"\f1b0"}.fa-spoon:before{content:"\f1b1"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-recycle:before{content:"\f1b8"}.fa-automobile:before,.fa-car:before{content:"\f1b9"}.fa-cab:before,.fa-taxi:before{content:"\f1ba"}.fa-tree:before{content:"\f1bb"}.fa-spotify:before{content:"\f1bc"}.fa-deviantart:before{content:"\f1bd"}.fa-soundcloud:before{content:"\f1be"}.fa-database:before{content:"\f1c0"}.fa-file-pdf-o:before{content:"\f1c1"}.fa-file-word-o:before{content:"\f1c2"}.fa-file-excel-o:before{content:"\f1c3"}.fa-file-powerpoint-o:before{content:"\f1c4"}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:"\f1c5"}.fa-file-zip-o:before,.fa-file-archive-o:before{content:"\f1c6"}.fa-file-sound-o:before,.fa-file-audio-o:before{content:"\f1c7"}.fa-file-movie-o:before,.fa-file-video-o:before{content:"\f1c8"}.fa-file-code-o:before{content:"\f1c9"}.fa-vine:before{content:"\f1ca"}.fa-codepen:before{content:"\f1cb"}.fa-jsfiddle:before{content:"\f1cc"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:"\f1cd"}.fa-circle-o-notch:before{content:"\f1ce"}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:"\f1d0"}.fa-ge:before,.fa-empire:before{content:"\f1d1"}.fa-git-square:before{content:"\f1d2"}.fa-git:before{content:"\f1d3"}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:"\f1d4"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-qq:before{content:"\f1d6"}.fa-wechat:before,.fa-weixin:before{content:"\f1d7"}.fa-send:before,.fa-paper-plane:before{content:"\f1d8"}.fa-send-o:before,.fa-paper-plane-o:before{content:"\f1d9"}.fa-history:before{content:"\f1da"}.fa-circle-thin:before{content:"\f1db"}.fa-header:before{content:"\f1dc"}.fa-paragraph:before{content:"\f1dd"}.fa-sliders:before{content:"\f1de"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-bomb:before{content:"\f1e2"}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:"\f1e3"}.fa-tty:before{content:"\f1e4"}.fa-binoculars:before{content:"\f1e5"}.fa-plug:before{content:"\f1e6"}.fa-slideshare:before{content:"\f1e7"}.fa-twitch:before{content:"\f1e8"}.fa-yelp:before{content:"\f1e9"}.fa-newspaper-o:before{content:"\f1ea"}.fa-wifi:before{content:"\f1eb"}.fa-calculator:before{content:"\f1ec"}.fa-paypal:before{content:"\f1ed"}.fa-google-wallet:before{content:"\f1ee"}.fa-cc-visa:before{content:"\f1f0"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-bell-slash:before{content:"\f1f6"}.fa-bell-slash-o:before{content:"\f1f7"}.fa-trash:before{content:"\f1f8"}.fa-copyright:before{content:"\f1f9"}.fa-at:before{content:"\f1fa"}.fa-eyedropper:before{content:"\f1fb"}.fa-paint-brush:before{content:"\f1fc"}.fa-birthday-cake:before{content:"\f1fd"}.fa-area-chart:before{content:"\f1fe"}.fa-pie-chart:before{content:"\f200"}.fa-line-chart:before{content:"\f201"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-bicycle:before{content:"\f206"}.fa-bus:before{content:"\f207"}.fa-ioxhost:before{content:"\f208"}.fa-angellist:before{content:"\f209"}.fa-cc:before{content:"\f20a"}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:"\f20b"}.fa-meanpath:before{content:"\f20c"}.fa-buysellads:before{content:"\f20d"}.fa-connectdevelop:before{content:"\f20e"}.fa-dashcube:before{content:"\f210"}.fa-forumbee:before{content:"\f211"}.fa-leanpub:before{content:"\f212"}.fa-sellsy:before{content:"\f213"}.fa-shirtsinbulk:before{content:"\f214"}.fa-simplybuilt:before{content:"\f215"}.fa-skyatlas:before{content:"\f216"}.fa-cart-plus:before{content:"\f217"}.fa-cart-arrow-down:before{content:"\f218"}.fa-diamond:before{content:"\f219"}.fa-ship:before{content:"\f21a"}.fa-user-secret:before{content:"\f21b"}.fa-motorcycle:before{content:"\f21c"}.fa-street-view:before{content:"\f21d"}.fa-heartbeat:before{content:"\f21e"}.fa-venus:before{content:"\f221"}.fa-mars:before{content:"\f222"}.fa-mercury:before{content:"\f223"}.fa-intersex:before,.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-venus-double:before{content:"\f226"}.fa-mars-double:before{content:"\f227"}.fa-venus-mars:before{content:"\f228"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-neuter:before{content:"\f22c"}.fa-genderless:before{content:"\f22d"}.fa-facebook-official:before{content:"\f230"}.fa-pinterest-p:before{content:"\f231"}.fa-whatsapp:before{content:"\f232"}.fa-server:before{content:"\f233"}.fa-user-plus:before{content:"\f234"}.fa-user-times:before{content:"\f235"}.fa-hotel:before,.fa-bed:before{content:"\f236"}.fa-viacoin:before{content:"\f237"}.fa-train:before{content:"\f238"}.fa-subway:before{content:"\f239"}.fa-medium:before{content:"\f23a"}.fa-yc:before,.fa-y-combinator:before{content:"\f23b"}.fa-optin-monster:before{content:"\f23c"}.fa-opencart:before{content:"\f23d"}.fa-expeditedssl:before{content:"\f23e"}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:"\f240"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:"\f241"}.fa-battery-2:before,.fa-battery-half:before{content:"\f242"}.fa-battery-1:before,.fa-battery-quarter:before{content:"\f243"}.fa-battery-0:before,.fa-battery-empty:before{content:"\f244"}.fa-mouse-pointer:before{content:"\f245"}.fa-i-cursor:before{content:"\f246"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-sticky-note:before{content:"\f249"}.fa-sticky-note-o:before{content:"\f24a"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-diners-club:before{content:"\f24c"}.fa-clone:before{content:"\f24d"}.fa-balance-scale:before{content:"\f24e"}.fa-hourglass-o:before{content:"\f250"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:"\f251"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:"\f253"}.fa-hourglass:before{content:"\f254"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:"\f255"}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:"\f256"}.fa-hand-scissors-o:before{content:"\f257"}.fa-hand-lizard-o:before{content:"\f258"}.fa-hand-spock-o:before{content:"\f259"}.fa-hand-pointer-o:before{content:"\f25a"}.fa-hand-peace-o:before{content:"\f25b"}.fa-trademark:before{content:"\f25c"}.fa-registered:before{content:"\f25d"}.fa-creative-commons:before{content:"\f25e"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-tripadvisor:before{content:"\f262"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-get-pocket:before{content:"\f265"}.fa-wikipedia-w:before{content:"\f266"}.fa-safari:before{content:"\f267"}.fa-chrome:before{content:"\f268"}.fa-firefox:before{content:"\f269"}.fa-opera:before{content:"\f26a"}.fa-internet-explorer:before{content:"\f26b"}.fa-tv:before,.fa-television:before{content:"\f26c"}.fa-contao:before{content:"\f26d"}.fa-500px:before{content:"\f26e"}.fa-amazon:before{content:"\f270"}.fa-calendar-plus-o:before{content:"\f271"}.fa-calendar-minus-o:before{content:"\f272"}.fa-calendar-times-o:before{content:"\f273"}.fa-calendar-check-o:before{content:"\f274"}.fa-industry:before{content:"\f275"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-map-o:before{content:"\f278"}.fa-map:before{content:"\f279"}.fa-commenting:before{content:"\f27a"}.fa-commenting-o:before{content:"\f27b"}.fa-houzz:before{content:"\f27c"}.fa-vimeo:before{content:"\f27d"}.fa-black-tie:before{content:"\f27e"}.fa-fonticons:before{content:"\f280"}.fa-reddit-alien:before{content:"\f281"}.fa-edge:before{content:"\f282"}.fa-credit-card-alt:before{content:"\f283"}.fa-codiepie:before{content:"\f284"}.fa-modx:before{content:"\f285"}.fa-fort-awesome:before{content:"\f286"}.fa-usb:before{content:"\f287"}.fa-product-hunt:before{content:"\f288"}.fa-mixcloud:before{content:"\f289"}.fa-scribd:before{content:"\f28a"}.fa-pause-circle:before{content:"\f28b"}.fa-pause-circle-o:before{content:"\f28c"}.fa-stop-circle:before{content:"\f28d"}.fa-stop-circle-o:before{content:"\f28e"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-hashtag:before{content:"\f292"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-percent:before{content:"\f295"}.fa-gitlab:before{content:"\f296"}.fa-wpbeginner:before{content:"\f297"}.fa-wpforms:before{content:"\f298"}.fa-envira:before{content:"\f299"}.fa-universal-access:before{content:"\f29a"}.fa-wheelchair-alt:before{content:"\f29b"}.fa-question-circle-o:before{content:"\f29c"}.fa-blind:before{content:"\f29d"}.fa-audio-description:before{content:"\f29e"}.fa-volume-control-phone:before{content:"\f2a0"}.fa-braille:before{content:"\f2a1"}.fa-assistive-listening-systems:before{content:"\f2a2"}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:"\f2a3"}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:"\f2a4"}.fa-glide:before{content:"\f2a5"}.fa-glide-g:before{content:"\f2a6"}.fa-signing:before,.fa-sign-language:before{content:"\f2a7"}.fa-low-vision:before{content:"\f2a8"}.fa-viadeo:before{content:"\f2a9"}.fa-viadeo-square:before{content:"\f2aa"}.fa-snapchat:before{content:"\f2ab"}.fa-snapchat-ghost:before{content:"\f2ac"}.fa-snapchat-square:before{content:"\f2ad"}.fa-pied-piper:before{content:"\f2ae"}.fa-first-order:before{content:"\f2b0"}.fa-yoast:before{content:"\f2b1"}.fa-themeisle:before{content:"\f2b2"}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:"\f2b3"}.fa-fa:before,.fa-font-awesome:before{content:"\f2b4"}.fa-handshake-o:before{content:"\f2b5"}.fa-envelope-open:before{content:"\f2b6"}.fa-envelope-open-o:before{content:"\f2b7"}.fa-linode:before{content:"\f2b8"}.fa-address-book:before{content:"\f2b9"}.fa-address-book-o:before{content:"\f2ba"}.fa-vcard:before,.fa-address-card:before{content:"\f2bb"}.fa-vcard-o:before,.fa-address-card-o:before{content:"\f2bc"}.fa-user-circle:before{content:"\f2bd"}.fa-user-circle-o:before{content:"\f2be"}.fa-user-o:before{content:"\f2c0"}.fa-id-badge:before{content:"\f2c1"}.fa-drivers-license:before,.fa-id-card:before{content:"\f2c2"}.fa-drivers-license-o:before,.fa-id-card-o:before{content:"\f2c3"}.fa-quora:before{content:"\f2c4"}.fa-free-code-camp:before{content:"\f2c5"}.fa-telegram:before{content:"\f2c6"}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:"\f2c7"}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:"\f2c8"}.fa-thermometer-2:before,.fa-thermometer-half:before{content:"\f2c9"}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:"\f2ca"}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:"\f2cb"}.fa-shower:before{content:"\f2cc"}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:"\f2cd"}.fa-podcast:before{content:"\f2ce"}.fa-window-maximize:before{content:"\f2d0"}.fa-window-minimize:before{content:"\f2d1"}.fa-window-restore:before{content:"\f2d2"}.fa-times-rectangle:before,.fa-window-close:before{content:"\f2d3"}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:"\f2d4"}.fa-bandcamp:before{content:"\f2d5"}.fa-grav:before{content:"\f2d6"}.fa-etsy:before{content:"\f2d7"}.fa-imdb:before{content:"\f2d8"}.fa-ravelry:before{content:"\f2d9"}.fa-eercast:before{content:"\f2da"}.fa-microchip:before{content:"\f2db"}.fa-snowflake-o:before{content:"\f2dc"}.fa-superpowers:before{content:"\f2dd"}.fa-wpexplorer:before{content:"\f2de"}.fa-meetup:before{content:"\f2e0"}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/FontAwesome.otf b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/FontAwesome.otf new file mode 100755 index 0000000000000..401ec0f36e4f7 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/FontAwesome.otf differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.eot b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.eot new file mode 100755 index 0000000000000..e9f60ca953f93 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.eot differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.svg b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.svg new file mode 100755 index 0000000000000..855c845e538b6 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.ttf b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.ttf new file mode 100755 index 0000000000000..35acda2fa1196 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.ttf differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff new file mode 100755 index 0000000000000..400014a4b06ee Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 new file mode 100755 index 0000000000000..4d13fc60404b9 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/highlight.js/styles/default.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/highlight.js/styles/default.css new file mode 100755 index 0000000000000..f1bfade31e5dc --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/highlight.js/styles/default.css @@ -0,0 +1,99 @@ +/* + +Original highlight.js style (c) Ivan Sagalaev + +*/ + +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: #F0F0F0; +} + + +/* Base color: saturation 0; */ + +.hljs, +.hljs-subst { + color: #444; +} + +.hljs-comment { + color: #888888; +} + +.hljs-keyword, +.hljs-attribute, +.hljs-selector-tag, +.hljs-meta-keyword, +.hljs-doctag, +.hljs-name { + font-weight: bold; +} + + +/* User color: hue: 0 */ + +.hljs-type, +.hljs-string, +.hljs-number, +.hljs-selector-id, +.hljs-selector-class, +.hljs-quote, +.hljs-template-tag, +.hljs-deletion { + color: #880000; +} + +.hljs-title, +.hljs-section { + color: #880000; + font-weight: bold; +} + +.hljs-regexp, +.hljs-symbol, +.hljs-variable, +.hljs-template-variable, +.hljs-link, +.hljs-selector-attr, +.hljs-selector-pseudo { + color: #BC6060; +} + + +/* Language color: hue: 90; */ + +.hljs-literal { + color: #78A960; +} + +.hljs-built_in, +.hljs-bullet, +.hljs-code, +.hljs-addition { + color: #397300; +} + + +/* Meta color: hue: 200 */ + +.hljs-meta { + color: #1f7199; +} + +.hljs-meta-string { + color: #4d99bf; +} + + +/* Misc effects */ + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/jquery.scrollto/jquery.scrollTo.min.js b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/jquery.scrollto/jquery.scrollTo.min.js new file mode 100755 index 0000000000000..65a020d92ad28 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/jquery.scrollto/jquery.scrollTo.min.js @@ -0,0 +1,7 @@ +/** + * Copyright (c) 2007-2015 Ariel Flesler - afleslergmailcom | http://flesler.blogspot.com + * Licensed under MIT + * @author Ariel Flesler + * @version 2.1.2 + */ +;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1=0&&c0&&b-1 in a)}var x=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ha(),z=ha(),A=ha(),B=function(a,b){return a===b&&(l=!0),0},C={}.hasOwnProperty,D=[],E=D.pop,F=D.push,G=D.push,H=D.slice,I=function(a,b){for(var c=0,d=a.length;c+~]|"+K+")"+K+"*"),S=new RegExp("="+K+"*([^\\]'\"]*?)"+K+"*\\]","g"),T=new RegExp(N),U=new RegExp("^"+L+"$"),V={ID:new RegExp("^#("+L+")"),CLASS:new RegExp("^\\.("+L+")"),TAG:new RegExp("^("+L+"|[*])"),ATTR:new RegExp("^"+M),PSEUDO:new RegExp("^"+N),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+K+"*(even|odd|(([+-]|)(\\d*)n|)"+K+"*(?:([+-]|)"+K+"*(\\d+)|))"+K+"*\\)|)","i"),bool:new RegExp("^(?:"+J+")$","i"),needsContext:new RegExp("^"+K+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+K+"*((?:-\\d)?\\d*)"+K+"*\\)|)(?=[^-]|$)","i")},W=/^(?:input|select|textarea|button)$/i,X=/^h\d$/i,Y=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,$=/[+~]/,_=new RegExp("\\\\([\\da-f]{1,6}"+K+"?|("+K+")|.)","ig"),aa=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:d<0?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},ba=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ca=function(a,b){return b?"\0"===a?"\ufffd":a.slice(0,-1)+"\\"+a.charCodeAt(a.length-1).toString(16)+" ":"\\"+a},da=function(){m()},ea=ta(function(a){return a.disabled===!0&&("form"in a||"label"in a)},{dir:"parentNode",next:"legend"});try{G.apply(D=H.call(v.childNodes),v.childNodes),D[v.childNodes.length].nodeType}catch(fa){G={apply:D.length?function(a,b){F.apply(a,H.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function ga(a,b,d,e){var f,h,j,k,l,o,r,s=b&&b.ownerDocument,w=b?b.nodeType:9;if(d=d||[],"string"!=typeof a||!a||1!==w&&9!==w&&11!==w)return d;if(!e&&((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,p)){if(11!==w&&(l=Z.exec(a)))if(f=l[1]){if(9===w){if(!(j=b.getElementById(f)))return d;if(j.id===f)return d.push(j),d}else if(s&&(j=s.getElementById(f))&&t(b,j)&&j.id===f)return d.push(j),d}else{if(l[2])return G.apply(d,b.getElementsByTagName(a)),d;if((f=l[3])&&c.getElementsByClassName&&b.getElementsByClassName)return G.apply(d,b.getElementsByClassName(f)),d}if(c.qsa&&!A[a+" "]&&(!q||!q.test(a))){if(1!==w)s=b,r=a;else if("object"!==b.nodeName.toLowerCase()){(k=b.getAttribute("id"))?k=k.replace(ba,ca):b.setAttribute("id",k=u),o=g(a),h=o.length;while(h--)o[h]="#"+k+" "+sa(o[h]);r=o.join(","),s=$.test(a)&&qa(b.parentNode)||b}if(r)try{return G.apply(d,s.querySelectorAll(r)),d}catch(x){}finally{k===u&&b.removeAttribute("id")}}}return i(a.replace(P,"$1"),b,d,e)}function ha(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ia(a){return a[u]=!0,a}function ja(a){var b=n.createElement("fieldset");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ka(a,b){var c=a.split("|"),e=c.length;while(e--)d.attrHandle[c[e]]=b}function la(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&a.sourceIndex-b.sourceIndex;if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function na(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function oa(a){return function(b){return"form"in b?b.parentNode&&b.disabled===!1?"label"in b?"label"in b.parentNode?b.parentNode.disabled===a:b.disabled===a:b.isDisabled===a||b.isDisabled!==!a&&ea(b)===a:b.disabled===a:"label"in b&&b.disabled===a}}function pa(a){return ia(function(b){return b=+b,ia(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function qa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=ga.support={},f=ga.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return!!b&&"HTML"!==b.nodeName},m=ga.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=n.documentElement,p=!f(n),v!==n&&(e=n.defaultView)&&e.top!==e&&(e.addEventListener?e.addEventListener("unload",da,!1):e.attachEvent&&e.attachEvent("onunload",da)),c.attributes=ja(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ja(function(a){return a.appendChild(n.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Y.test(n.getElementsByClassName),c.getById=ja(function(a){return o.appendChild(a).id=u,!n.getElementsByName||!n.getElementsByName(u).length}),c.getById?(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){return a.getAttribute("id")===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c?[c]:[]}}):(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c,d,e,f=b.getElementById(a);if(f){if(c=f.getAttributeNode("id"),c&&c.value===a)return[f];e=b.getElementsByName(a),d=0;while(f=e[d++])if(c=f.getAttributeNode("id"),c&&c.value===a)return[f]}return[]}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){if("undefined"!=typeof b.getElementsByClassName&&p)return b.getElementsByClassName(a)},r=[],q=[],(c.qsa=Y.test(n.querySelectorAll))&&(ja(function(a){o.appendChild(a).innerHTML="",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+K+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+K+"*(?:value|"+J+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ja(function(a){a.innerHTML="";var b=n.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+K+"*[*^$|!~]?="),2!==a.querySelectorAll(":enabled").length&&q.push(":enabled",":disabled"),o.appendChild(a).disabled=!0,2!==a.querySelectorAll(":disabled").length&&q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=Y.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ja(function(a){c.disconnectedMatch=s.call(a,"*"),s.call(a,"[s!='']:x"),r.push("!=",N)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=Y.test(o.compareDocumentPosition),t=b||Y.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===n||a.ownerDocument===v&&t(v,a)?-1:b===n||b.ownerDocument===v&&t(v,b)?1:k?I(k,a)-I(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,g=[a],h=[b];if(!e||!f)return a===n?-1:b===n?1:e?-1:f?1:k?I(k,a)-I(k,b):0;if(e===f)return la(a,b);c=a;while(c=c.parentNode)g.unshift(c);c=b;while(c=c.parentNode)h.unshift(c);while(g[d]===h[d])d++;return d?la(g[d],h[d]):g[d]===v?-1:h[d]===v?1:0},n):n},ga.matches=function(a,b){return ga(a,null,null,b)},ga.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(S,"='$1']"),c.matchesSelector&&p&&!A[b+" "]&&(!r||!r.test(b))&&(!q||!q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return ga(b,n,null,[a]).length>0},ga.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},ga.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&C.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},ga.escape=function(a){return(a+"").replace(ba,ca)},ga.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},ga.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=ga.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=ga.selectors={cacheLength:50,createPseudo:ia,match:V,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(_,aa),a[3]=(a[3]||a[4]||a[5]||"").replace(_,aa),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||ga.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&ga.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return V.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&T.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(_,aa).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+K+")"+a+"("+K+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=ga.attr(d,a);return null==e?"!="===b:!b||(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(O," ")+" ").indexOf(c)>-1:"|="===b&&(e===c||e.slice(0,c.length+1)===c+"-"))}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h,t=!1;if(q){if(f){while(p){m=b;while(m=m[p])if(h?m.nodeName.toLowerCase()===r:1===m.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){m=q,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n&&j[2],m=n&&q.childNodes[n];while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if(1===m.nodeType&&++t&&m===b){k[a]=[w,n,t];break}}else if(s&&(m=b,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n),t===!1)while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if((h?m.nodeName.toLowerCase()===r:1===m.nodeType)&&++t&&(s&&(l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),k[a]=[w,t]),m===b))break;return t-=e,t===d||t%d===0&&t/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||ga.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ia(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=I(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ia(function(a){var b=[],c=[],d=h(a.replace(P,"$1"));return d[u]?ia(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ia(function(a){return function(b){return ga(a,b).length>0}}),contains:ia(function(a){return a=a.replace(_,aa),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ia(function(a){return U.test(a||"")||ga.error("unsupported lang: "+a),a=a.replace(_,aa).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:oa(!1),disabled:oa(!0),checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return X.test(a.nodeName)},input:function(a){return W.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:pa(function(){return[0]}),last:pa(function(a,b){return[b-1]}),eq:pa(function(a,b,c){return[c<0?c+b:c]}),even:pa(function(a,b){for(var c=0;c=0;)a.push(d);return a}),gt:pa(function(a,b,c){for(var d=c<0?c+b:c;++d1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function va(a,b,c){for(var d=0,e=b.length;d-1&&(f[j]=!(g[j]=l))}}else r=wa(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):G.apply(g,r)})}function ya(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=ta(function(a){return a===b},h,!0),l=ta(function(a){return I(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];i1&&ua(m),i>1&&sa(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(P,"$1"),c,i0,e=a.length>0,f=function(f,g,h,i,k){var l,o,q,r=0,s="0",t=f&&[],u=[],v=j,x=f||e&&d.find.TAG("*",k),y=w+=null==v?1:Math.random()||.1,z=x.length;for(k&&(j=g===n||g||k);s!==z&&null!=(l=x[s]);s++){if(e&&l){o=0,g||l.ownerDocument===n||(m(l),h=!p);while(q=a[o++])if(q(l,g||n,h)){i.push(l);break}k&&(w=y)}c&&((l=!q&&l)&&r--,f&&t.push(l))}if(r+=s,c&&s!==r){o=0;while(q=b[o++])q(t,u,g,h);if(f){if(r>0)while(s--)t[s]||u[s]||(u[s]=E.call(i));u=wa(u)}G.apply(i,u),k&&!f&&u.length>0&&r+b.length>1&&ga.uniqueSort(i)}return k&&(w=y,j=v),t};return c?ia(f):f}return h=ga.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=ya(b[c]),f[u]?d.push(f):e.push(f);f=A(a,za(e,d)),f.selector=a}return f},i=ga.select=function(a,b,c,e){var f,i,j,k,l,m="function"==typeof a&&a,n=!e&&g(a=m.selector||a);if(c=c||[],1===n.length){if(i=n[0]=n[0].slice(0),i.length>2&&"ID"===(j=i[0]).type&&9===b.nodeType&&p&&d.relative[i[1].type]){if(b=(d.find.ID(j.matches[0].replace(_,aa),b)||[])[0],!b)return c;m&&(b=b.parentNode),a=a.slice(i.shift().value.length)}f=V.needsContext.test(a)?0:i.length;while(f--){if(j=i[f],d.relative[k=j.type])break;if((l=d.find[k])&&(e=l(j.matches[0].replace(_,aa),$.test(i[0].type)&&qa(b.parentNode)||b))){if(i.splice(f,1),a=e.length&&sa(i),!a)return G.apply(c,e),c;break}}}return(m||h(a,n))(e,b,!p,c,!b||$.test(a)&&qa(b.parentNode)||b),c},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ja(function(a){return 1&a.compareDocumentPosition(n.createElement("fieldset"))}),ja(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||ka("type|href|height|width",function(a,b,c){if(!c)return a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ja(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ka("value",function(a,b,c){if(!c&&"input"===a.nodeName.toLowerCase())return a.defaultValue}),ja(function(a){return null==a.getAttribute("disabled")})||ka(J,function(a,b,c){var d;if(!c)return a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),ga}(a);r.find=x,r.expr=x.selectors,r.expr[":"]=r.expr.pseudos,r.uniqueSort=r.unique=x.uniqueSort,r.text=x.getText,r.isXMLDoc=x.isXML,r.contains=x.contains,r.escapeSelector=x.escape;var y=function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&r(a).is(c))break;d.push(a)}return d},z=function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c},A=r.expr.match.needsContext;function B(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()}var C=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i,D=/^.[^:#\[\.,]*$/;function E(a,b,c){return r.isFunction(b)?r.grep(a,function(a,d){return!!b.call(a,d,a)!==c}):b.nodeType?r.grep(a,function(a){return a===b!==c}):"string"!=typeof b?r.grep(a,function(a){return i.call(b,a)>-1!==c}):D.test(b)?r.filter(b,a,c):(b=r.filter(b,a),r.grep(a,function(a){return i.call(b,a)>-1!==c&&1===a.nodeType}))}r.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?r.find.matchesSelector(d,a)?[d]:[]:r.find.matches(a,r.grep(b,function(a){return 1===a.nodeType}))},r.fn.extend({find:function(a){var b,c,d=this.length,e=this;if("string"!=typeof a)return this.pushStack(r(a).filter(function(){for(b=0;b1?r.uniqueSort(c):c},filter:function(a){return this.pushStack(E(this,a||[],!1))},not:function(a){return this.pushStack(E(this,a||[],!0))},is:function(a){return!!E(this,"string"==typeof a&&A.test(a)?r(a):a||[],!1).length}});var F,G=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,H=r.fn.init=function(a,b,c){var e,f;if(!a)return this;if(c=c||F,"string"==typeof a){if(e="<"===a[0]&&">"===a[a.length-1]&&a.length>=3?[null,a,null]:G.exec(a),!e||!e[1]&&b)return!b||b.jquery?(b||c).find(a):this.constructor(b).find(a);if(e[1]){if(b=b instanceof r?b[0]:b,r.merge(this,r.parseHTML(e[1],b&&b.nodeType?b.ownerDocument||b:d,!0)),C.test(e[1])&&r.isPlainObject(b))for(e in b)r.isFunction(this[e])?this[e](b[e]):this.attr(e,b[e]);return this}return f=d.getElementById(e[2]),f&&(this[0]=f,this.length=1),this}return a.nodeType?(this[0]=a,this.length=1,this):r.isFunction(a)?void 0!==c.ready?c.ready(a):a(r):r.makeArray(a,this)};H.prototype=r.fn,F=r(d);var I=/^(?:parents|prev(?:Until|All))/,J={children:!0,contents:!0,next:!0,prev:!0};r.fn.extend({has:function(a){var b=r(a,this),c=b.length;return this.filter(function(){for(var a=0;a-1:1===c.nodeType&&r.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?r.uniqueSort(f):f)},index:function(a){return a?"string"==typeof a?i.call(r(a),this[0]):i.call(this,a.jquery?a[0]:a):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(r.uniqueSort(r.merge(this.get(),r(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function K(a,b){while((a=a[b])&&1!==a.nodeType);return a}r.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return y(a,"parentNode")},parentsUntil:function(a,b,c){return y(a,"parentNode",c)},next:function(a){return K(a,"nextSibling")},prev:function(a){return K(a,"previousSibling")},nextAll:function(a){return y(a,"nextSibling")},prevAll:function(a){return y(a,"previousSibling")},nextUntil:function(a,b,c){return y(a,"nextSibling",c)},prevUntil:function(a,b,c){return y(a,"previousSibling",c)},siblings:function(a){return z((a.parentNode||{}).firstChild,a)},children:function(a){return z(a.firstChild)},contents:function(a){return B(a,"iframe")?a.contentDocument:(B(a,"template")&&(a=a.content||a),r.merge([],a.childNodes))}},function(a,b){r.fn[a]=function(c,d){var e=r.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=r.filter(d,e)),this.length>1&&(J[a]||r.uniqueSort(e),I.test(a)&&e.reverse()),this.pushStack(e)}});var L=/[^\x20\t\r\n\f]+/g;function M(a){var b={};return r.each(a.match(L)||[],function(a,c){b[c]=!0}),b}r.Callbacks=function(a){a="string"==typeof a?M(a):r.extend({},a);var b,c,d,e,f=[],g=[],h=-1,i=function(){for(e=e||a.once,d=b=!0;g.length;h=-1){c=g.shift();while(++h-1)f.splice(c,1),c<=h&&h--}),this},has:function(a){return a?r.inArray(a,f)>-1:f.length>0},empty:function(){return f&&(f=[]),this},disable:function(){return e=g=[],f=c="",this},disabled:function(){return!f},lock:function(){return e=g=[],c||b||(f=c=""),this},locked:function(){return!!e},fireWith:function(a,c){return e||(c=c||[],c=[a,c.slice?c.slice():c],g.push(c),b||i()),this},fire:function(){return j.fireWith(this,arguments),this},fired:function(){return!!d}};return j};function N(a){return a}function O(a){throw a}function P(a,b,c,d){var e;try{a&&r.isFunction(e=a.promise)?e.call(a).done(b).fail(c):a&&r.isFunction(e=a.then)?e.call(a,b,c):b.apply(void 0,[a].slice(d))}catch(a){c.apply(void 0,[a])}}r.extend({Deferred:function(b){var c=[["notify","progress",r.Callbacks("memory"),r.Callbacks("memory"),2],["resolve","done",r.Callbacks("once memory"),r.Callbacks("once memory"),0,"resolved"],["reject","fail",r.Callbacks("once memory"),r.Callbacks("once memory"),1,"rejected"]],d="pending",e={state:function(){return d},always:function(){return f.done(arguments).fail(arguments),this},"catch":function(a){return e.then(null,a)},pipe:function(){var a=arguments;return r.Deferred(function(b){r.each(c,function(c,d){var e=r.isFunction(a[d[4]])&&a[d[4]];f[d[1]](function(){var a=e&&e.apply(this,arguments);a&&r.isFunction(a.promise)?a.promise().progress(b.notify).done(b.resolve).fail(b.reject):b[d[0]+"With"](this,e?[a]:arguments)})}),a=null}).promise()},then:function(b,d,e){var f=0;function g(b,c,d,e){return function(){var h=this,i=arguments,j=function(){var a,j;if(!(b=f&&(d!==O&&(h=void 0,i=[a]),c.rejectWith(h,i))}};b?k():(r.Deferred.getStackHook&&(k.stackTrace=r.Deferred.getStackHook()),a.setTimeout(k))}}return r.Deferred(function(a){c[0][3].add(g(0,a,r.isFunction(e)?e:N,a.notifyWith)),c[1][3].add(g(0,a,r.isFunction(b)?b:N)),c[2][3].add(g(0,a,r.isFunction(d)?d:O))}).promise()},promise:function(a){return null!=a?r.extend(a,e):e}},f={};return r.each(c,function(a,b){var g=b[2],h=b[5];e[b[1]]=g.add,h&&g.add(function(){d=h},c[3-a][2].disable,c[0][2].lock),g.add(b[3].fire),f[b[0]]=function(){return f[b[0]+"With"](this===f?void 0:this,arguments),this},f[b[0]+"With"]=g.fireWith}),e.promise(f),b&&b.call(f,f),f},when:function(a){var b=arguments.length,c=b,d=Array(c),e=f.call(arguments),g=r.Deferred(),h=function(a){return function(c){d[a]=this,e[a]=arguments.length>1?f.call(arguments):c,--b||g.resolveWith(d,e)}};if(b<=1&&(P(a,g.done(h(c)).resolve,g.reject,!b),"pending"===g.state()||r.isFunction(e[c]&&e[c].then)))return g.then();while(c--)P(e[c],h(c),g.reject);return g.promise()}});var Q=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;r.Deferred.exceptionHook=function(b,c){a.console&&a.console.warn&&b&&Q.test(b.name)&&a.console.warn("jQuery.Deferred exception: "+b.message,b.stack,c)},r.readyException=function(b){a.setTimeout(function(){throw b})};var R=r.Deferred();r.fn.ready=function(a){return R.then(a)["catch"](function(a){r.readyException(a)}),this},r.extend({isReady:!1,readyWait:1,ready:function(a){(a===!0?--r.readyWait:r.isReady)||(r.isReady=!0,a!==!0&&--r.readyWait>0||R.resolveWith(d,[r]))}}),r.ready.then=R.then;function S(){d.removeEventListener("DOMContentLoaded",S), +a.removeEventListener("load",S),r.ready()}"complete"===d.readyState||"loading"!==d.readyState&&!d.documentElement.doScroll?a.setTimeout(r.ready):(d.addEventListener("DOMContentLoaded",S),a.addEventListener("load",S));var T=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===r.type(c)){e=!0;for(h in c)T(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,r.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(r(a),c)})),b))for(;h1,null,!0)},removeData:function(a){return this.each(function(){X.remove(this,a)})}}),r.extend({queue:function(a,b,c){var d;if(a)return b=(b||"fx")+"queue",d=W.get(a,b),c&&(!d||Array.isArray(c)?d=W.access(a,b,r.makeArray(c)):d.push(c)),d||[]},dequeue:function(a,b){b=b||"fx";var c=r.queue(a,b),d=c.length,e=c.shift(),f=r._queueHooks(a,b),g=function(){r.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return W.get(a,c)||W.access(a,c,{empty:r.Callbacks("once memory").add(function(){W.remove(a,[b+"queue",c])})})}}),r.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length\x20\t\r\n\f]+)/i,la=/^$|\/(?:java|ecma)script/i,ma={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};ma.optgroup=ma.option,ma.tbody=ma.tfoot=ma.colgroup=ma.caption=ma.thead,ma.th=ma.td;function na(a,b){var c;return c="undefined"!=typeof a.getElementsByTagName?a.getElementsByTagName(b||"*"):"undefined"!=typeof a.querySelectorAll?a.querySelectorAll(b||"*"):[],void 0===b||b&&B(a,b)?r.merge([a],c):c}function oa(a,b){for(var c=0,d=a.length;c-1)e&&e.push(f);else if(j=r.contains(f.ownerDocument,f),g=na(l.appendChild(f),"script"),j&&oa(g),c){k=0;while(f=g[k++])la.test(f.type||"")&&c.push(f)}return l}!function(){var a=d.createDocumentFragment(),b=a.appendChild(d.createElement("div")),c=d.createElement("input");c.setAttribute("type","radio"),c.setAttribute("checked","checked"),c.setAttribute("name","t"),b.appendChild(c),o.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,b.innerHTML="",o.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue}();var ra=d.documentElement,sa=/^key/,ta=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,ua=/^([^.]*)(?:\.(.+)|)/;function va(){return!0}function wa(){return!1}function xa(){try{return d.activeElement}catch(a){}}function ya(a,b,c,d,e,f){var g,h;if("object"==typeof b){"string"!=typeof c&&(d=d||c,c=void 0);for(h in b)ya(a,h,c,d,b[h],f);return a}if(null==d&&null==e?(e=c,d=c=void 0):null==e&&("string"==typeof c?(e=d,d=void 0):(e=d,d=c,c=void 0)),e===!1)e=wa;else if(!e)return a;return 1===f&&(g=e,e=function(a){return r().off(a),g.apply(this,arguments)},e.guid=g.guid||(g.guid=r.guid++)),a.each(function(){r.event.add(this,b,e,d,c)})}r.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.get(a);if(q){c.handler&&(f=c,c=f.handler,e=f.selector),e&&r.find.matchesSelector(ra,e),c.guid||(c.guid=r.guid++),(i=q.events)||(i=q.events={}),(g=q.handle)||(g=q.handle=function(b){return"undefined"!=typeof r&&r.event.triggered!==b.type?r.event.dispatch.apply(a,arguments):void 0}),b=(b||"").match(L)||[""],j=b.length;while(j--)h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n&&(l=r.event.special[n]||{},n=(e?l.delegateType:l.bindType)||n,l=r.event.special[n]||{},k=r.extend({type:n,origType:p,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&r.expr.match.needsContext.test(e),namespace:o.join(".")},f),(m=i[n])||(m=i[n]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,o,g)!==!1||a.addEventListener&&a.addEventListener(n,g)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),r.event.global[n]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.hasData(a)&&W.get(a);if(q&&(i=q.events)){b=(b||"").match(L)||[""],j=b.length;while(j--)if(h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n){l=r.event.special[n]||{},n=(d?l.delegateType:l.bindType)||n,m=i[n]||[],h=h[2]&&new RegExp("(^|\\.)"+o.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&p!==k.origType||c&&c.guid!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,o,q.handle)!==!1||r.removeEvent(a,n,q.handle),delete i[n])}else for(n in i)r.event.remove(a,n+b[j],c,d,!0);r.isEmptyObject(i)&&W.remove(a,"handle events")}},dispatch:function(a){var b=r.event.fix(a),c,d,e,f,g,h,i=new Array(arguments.length),j=(W.get(this,"events")||{})[b.type]||[],k=r.event.special[b.type]||{};for(i[0]=b,c=1;c=1))for(;j!==this;j=j.parentNode||this)if(1===j.nodeType&&("click"!==a.type||j.disabled!==!0)){for(f=[],g={},c=0;c-1:r.find(e,this,null,[j]).length),g[e]&&f.push(d);f.length&&h.push({elem:j,handlers:f})}return j=this,i\x20\t\r\n\f]*)[^>]*)\/>/gi,Aa=/\s*$/g;function Ea(a,b){return B(a,"table")&&B(11!==b.nodeType?b:b.firstChild,"tr")?r(">tbody",a)[0]||a:a}function Fa(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function Ga(a){var b=Ca.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Ha(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(W.hasData(a)&&(f=W.access(a),g=W.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;c1&&"string"==typeof q&&!o.checkClone&&Ba.test(q))return a.each(function(e){var f=a.eq(e);s&&(b[0]=q.call(this,e,f.html())),Ja(f,b,c,d)});if(m&&(e=qa(b,a[0].ownerDocument,!1,a,d),f=e.firstChild,1===e.childNodes.length&&(e=f),f||d)){for(h=r.map(na(e,"script"),Fa),i=h.length;l")},clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=r.contains(a.ownerDocument,a);if(!(o.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||r.isXMLDoc(a)))for(g=na(h),f=na(a),d=0,e=f.length;d0&&oa(g,!i&&na(a,"script")),h},cleanData:function(a){for(var b,c,d,e=r.event.special,f=0;void 0!==(c=a[f]);f++)if(U(c)){if(b=c[W.expando]){if(b.events)for(d in b.events)e[d]?r.event.remove(c,d):r.removeEvent(c,d,b.handle);c[W.expando]=void 0}c[X.expando]&&(c[X.expando]=void 0)}}}),r.fn.extend({detach:function(a){return Ka(this,a,!0)},remove:function(a){return Ka(this,a)},text:function(a){return T(this,function(a){return void 0===a?r.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=a)})},null,a,arguments.length)},append:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.appendChild(a)}})},prepend:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(r.cleanData(na(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null!=a&&a,b=null==b?a:b,this.map(function(){return r.clone(this,a,b)})},html:function(a){return T(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!Aa.test(a)&&!ma[(ka.exec(a)||["",""])[1].toLowerCase()]){a=r.htmlPrefilter(a);try{for(;c1)}});function _a(a,b,c,d,e){return new _a.prototype.init(a,b,c,d,e)}r.Tween=_a,_a.prototype={constructor:_a,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||r.easing._default,this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(r.cssNumber[c]?"":"px")},cur:function(){var a=_a.propHooks[this.prop];return a&&a.get?a.get(this):_a.propHooks._default.get(this)},run:function(a){var b,c=_a.propHooks[this.prop];return this.options.duration?this.pos=b=r.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):this.pos=b=a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):_a.propHooks._default.set(this),this}},_a.prototype.init.prototype=_a.prototype,_a.propHooks={_default:{get:function(a){var b;return 1!==a.elem.nodeType||null!=a.elem[a.prop]&&null==a.elem.style[a.prop]?a.elem[a.prop]:(b=r.css(a.elem,a.prop,""),b&&"auto"!==b?b:0)},set:function(a){r.fx.step[a.prop]?r.fx.step[a.prop](a):1!==a.elem.nodeType||null==a.elem.style[r.cssProps[a.prop]]&&!r.cssHooks[a.prop]?a.elem[a.prop]=a.now:r.style(a.elem,a.prop,a.now+a.unit)}}},_a.propHooks.scrollTop=_a.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},r.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2},_default:"swing"},r.fx=_a.prototype.init,r.fx.step={};var ab,bb,cb=/^(?:toggle|show|hide)$/,db=/queueHooks$/;function eb(){bb&&(d.hidden===!1&&a.requestAnimationFrame?a.requestAnimationFrame(eb):a.setTimeout(eb,r.fx.interval),r.fx.tick())}function fb(){return a.setTimeout(function(){ab=void 0}),ab=r.now()}function gb(a,b){var c,d=0,e={height:a};for(b=b?1:0;d<4;d+=2-b)c=ca[d],e["margin"+c]=e["padding"+c]=a;return b&&(e.opacity=e.width=a),e}function hb(a,b,c){for(var d,e=(kb.tweeners[b]||[]).concat(kb.tweeners["*"]),f=0,g=e.length;f1)},removeAttr:function(a){return this.each(function(){r.removeAttr(this,a)})}}),r.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return"undefined"==typeof a.getAttribute?r.prop(a,b,c):(1===f&&r.isXMLDoc(a)||(e=r.attrHooks[b.toLowerCase()]||(r.expr.match.bool.test(b)?lb:void 0)),void 0!==c?null===c?void r.removeAttr(a,b):e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:(a.setAttribute(b,c+""),c):e&&"get"in e&&null!==(d=e.get(a,b))?d:(d=r.find.attr(a,b), +null==d?void 0:d))},attrHooks:{type:{set:function(a,b){if(!o.radioValue&&"radio"===b&&B(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}},removeAttr:function(a,b){var c,d=0,e=b&&b.match(L);if(e&&1===a.nodeType)while(c=e[d++])a.removeAttribute(c)}}),lb={set:function(a,b,c){return b===!1?r.removeAttr(a,c):a.setAttribute(c,c),c}},r.each(r.expr.match.bool.source.match(/\w+/g),function(a,b){var c=mb[b]||r.find.attr;mb[b]=function(a,b,d){var e,f,g=b.toLowerCase();return d||(f=mb[g],mb[g]=e,e=null!=c(a,b,d)?g:null,mb[g]=f),e}});var nb=/^(?:input|select|textarea|button)$/i,ob=/^(?:a|area)$/i;r.fn.extend({prop:function(a,b){return T(this,r.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[r.propFix[a]||a]})}}),r.extend({prop:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return 1===f&&r.isXMLDoc(a)||(b=r.propFix[b]||b,e=r.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=r.find.attr(a,"tabindex");return b?parseInt(b,10):nb.test(a.nodeName)||ob.test(a.nodeName)&&a.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),o.optSelected||(r.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null},set:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}}),r.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){r.propFix[this.toLowerCase()]=this});function pb(a){var b=a.match(L)||[];return b.join(" ")}function qb(a){return a.getAttribute&&a.getAttribute("class")||""}r.fn.extend({addClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).addClass(a.call(this,b,qb(this)))});if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])d.indexOf(" "+f+" ")<0&&(d+=f+" ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},removeClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).removeClass(a.call(this,b,qb(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])while(d.indexOf(" "+f+" ")>-1)d=d.replace(" "+f+" "," ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):r.isFunction(a)?this.each(function(c){r(this).toggleClass(a.call(this,c,qb(this),b),b)}):this.each(function(){var b,d,e,f;if("string"===c){d=0,e=r(this),f=a.match(L)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else void 0!==a&&"boolean"!==c||(b=qb(this),b&&W.set(this,"__className__",b),this.setAttribute&&this.setAttribute("class",b||a===!1?"":W.get(this,"__className__")||""))})},hasClass:function(a){var b,c,d=0;b=" "+a+" ";while(c=this[d++])if(1===c.nodeType&&(" "+pb(qb(c))+" ").indexOf(b)>-1)return!0;return!1}});var rb=/\r/g;r.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=r.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,r(this).val()):a,null==e?e="":"number"==typeof e?e+="":Array.isArray(e)&&(e=r.map(e,function(a){return null==a?"":a+""})),b=r.valHooks[this.type]||r.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=r.valHooks[e.type]||r.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(rb,""):null==c?"":c)}}}),r.extend({valHooks:{option:{get:function(a){var b=r.find.attr(a,"value");return null!=b?b:pb(r.text(a))}},select:{get:function(a){var b,c,d,e=a.options,f=a.selectedIndex,g="select-one"===a.type,h=g?null:[],i=g?f+1:e.length;for(d=f<0?i:g?f:0;d-1)&&(c=!0);return c||(a.selectedIndex=-1),f}}}}),r.each(["radio","checkbox"],function(){r.valHooks[this]={set:function(a,b){if(Array.isArray(b))return a.checked=r.inArray(r(a).val(),b)>-1}},o.checkOn||(r.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var sb=/^(?:focusinfocus|focusoutblur)$/;r.extend(r.event,{trigger:function(b,c,e,f){var g,h,i,j,k,m,n,o=[e||d],p=l.call(b,"type")?b.type:b,q=l.call(b,"namespace")?b.namespace.split("."):[];if(h=i=e=e||d,3!==e.nodeType&&8!==e.nodeType&&!sb.test(p+r.event.triggered)&&(p.indexOf(".")>-1&&(q=p.split("."),p=q.shift(),q.sort()),k=p.indexOf(":")<0&&"on"+p,b=b[r.expando]?b:new r.Event(p,"object"==typeof b&&b),b.isTrigger=f?2:3,b.namespace=q.join("."),b.rnamespace=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=e),c=null==c?[b]:r.makeArray(c,[b]),n=r.event.special[p]||{},f||!n.trigger||n.trigger.apply(e,c)!==!1)){if(!f&&!n.noBubble&&!r.isWindow(e)){for(j=n.delegateType||p,sb.test(j+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),i=h;i===(e.ownerDocument||d)&&o.push(i.defaultView||i.parentWindow||a)}g=0;while((h=o[g++])&&!b.isPropagationStopped())b.type=g>1?j:n.bindType||p,m=(W.get(h,"events")||{})[b.type]&&W.get(h,"handle"),m&&m.apply(h,c),m=k&&h[k],m&&m.apply&&U(h)&&(b.result=m.apply(h,c),b.result===!1&&b.preventDefault());return b.type=p,f||b.isDefaultPrevented()||n._default&&n._default.apply(o.pop(),c)!==!1||!U(e)||k&&r.isFunction(e[p])&&!r.isWindow(e)&&(i=e[k],i&&(e[k]=null),r.event.triggered=p,e[p](),r.event.triggered=void 0,i&&(e[k]=i)),b.result}},simulate:function(a,b,c){var d=r.extend(new r.Event,c,{type:a,isSimulated:!0});r.event.trigger(d,null,b)}}),r.fn.extend({trigger:function(a,b){return this.each(function(){r.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];if(c)return r.event.trigger(a,b,c,!0)}}),r.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(a,b){r.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),r.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}}),o.focusin="onfocusin"in a,o.focusin||r.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){r.event.simulate(b,a.target,r.event.fix(a))};r.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=W.access(d,b);e||d.addEventListener(a,c,!0),W.access(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=W.access(d,b)-1;e?W.access(d,b,e):(d.removeEventListener(a,c,!0),W.remove(d,b))}}});var tb=a.location,ub=r.now(),vb=/\?/;r.parseXML=function(b){var c;if(!b||"string"!=typeof b)return null;try{c=(new a.DOMParser).parseFromString(b,"text/xml")}catch(d){c=void 0}return c&&!c.getElementsByTagName("parsererror").length||r.error("Invalid XML: "+b),c};var wb=/\[\]$/,xb=/\r?\n/g,yb=/^(?:submit|button|image|reset|file)$/i,zb=/^(?:input|select|textarea|keygen)/i;function Ab(a,b,c,d){var e;if(Array.isArray(b))r.each(b,function(b,e){c||wb.test(a)?d(a,e):Ab(a+"["+("object"==typeof e&&null!=e?b:"")+"]",e,c,d)});else if(c||"object"!==r.type(b))d(a,b);else for(e in b)Ab(a+"["+e+"]",b[e],c,d)}r.param=function(a,b){var c,d=[],e=function(a,b){var c=r.isFunction(b)?b():b;d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(null==c?"":c)};if(Array.isArray(a)||a.jquery&&!r.isPlainObject(a))r.each(a,function(){e(this.name,this.value)});else for(c in a)Ab(c,a[c],b,e);return d.join("&")},r.fn.extend({serialize:function(){return r.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=r.prop(this,"elements");return a?r.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!r(this).is(":disabled")&&zb.test(this.nodeName)&&!yb.test(a)&&(this.checked||!ja.test(a))}).map(function(a,b){var c=r(this).val();return null==c?null:Array.isArray(c)?r.map(c,function(a){return{name:b.name,value:a.replace(xb,"\r\n")}}):{name:b.name,value:c.replace(xb,"\r\n")}}).get()}});var Bb=/%20/g,Cb=/#.*$/,Db=/([?&])_=[^&]*/,Eb=/^(.*?):[ \t]*([^\r\n]*)$/gm,Fb=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Gb=/^(?:GET|HEAD)$/,Hb=/^\/\//,Ib={},Jb={},Kb="*/".concat("*"),Lb=d.createElement("a");Lb.href=tb.href;function Mb(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(L)||[];if(r.isFunction(c))while(d=f[e++])"+"===d[0]?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Nb(a,b,c,d){var e={},f=a===Jb;function g(h){var i;return e[h]=!0,r.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Ob(a,b){var c,d,e=r.ajaxSettings.flatOptions||{};for(c in b)void 0!==b[c]&&((e[c]?a:d||(d={}))[c]=b[c]);return d&&r.extend(!0,a,d),a}function Pb(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===d&&(d=a.mimeType||b.getResponseHeader("Content-Type"));if(d)for(e in h)if(h[e]&&h[e].test(d)){i.unshift(e);break}if(i[0]in c)f=i[0];else{for(e in c){if(!i[0]||a.converters[e+" "+i[0]]){f=e;break}g||(g=e)}f=f||g}if(f)return f!==i[0]&&i.unshift(f),c[f]}function Qb(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}r.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:tb.href,type:"GET",isLocal:Fb.test(tb.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Kb,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":r.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Ob(Ob(a,r.ajaxSettings),b):Ob(r.ajaxSettings,a)},ajaxPrefilter:Mb(Ib),ajaxTransport:Mb(Jb),ajax:function(b,c){"object"==typeof b&&(c=b,b=void 0),c=c||{};var e,f,g,h,i,j,k,l,m,n,o=r.ajaxSetup({},c),p=o.context||o,q=o.context&&(p.nodeType||p.jquery)?r(p):r.event,s=r.Deferred(),t=r.Callbacks("once memory"),u=o.statusCode||{},v={},w={},x="canceled",y={readyState:0,getResponseHeader:function(a){var b;if(k){if(!h){h={};while(b=Eb.exec(g))h[b[1].toLowerCase()]=b[2]}b=h[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return k?g:null},setRequestHeader:function(a,b){return null==k&&(a=w[a.toLowerCase()]=w[a.toLowerCase()]||a,v[a]=b),this},overrideMimeType:function(a){return null==k&&(o.mimeType=a),this},statusCode:function(a){var b;if(a)if(k)y.always(a[y.status]);else for(b in a)u[b]=[u[b],a[b]];return this},abort:function(a){var b=a||x;return e&&e.abort(b),A(0,b),this}};if(s.promise(y),o.url=((b||o.url||tb.href)+"").replace(Hb,tb.protocol+"//"),o.type=c.method||c.type||o.method||o.type,o.dataTypes=(o.dataType||"*").toLowerCase().match(L)||[""],null==o.crossDomain){j=d.createElement("a");try{j.href=o.url,j.href=j.href,o.crossDomain=Lb.protocol+"//"+Lb.host!=j.protocol+"//"+j.host}catch(z){o.crossDomain=!0}}if(o.data&&o.processData&&"string"!=typeof o.data&&(o.data=r.param(o.data,o.traditional)),Nb(Ib,o,c,y),k)return y;l=r.event&&o.global,l&&0===r.active++&&r.event.trigger("ajaxStart"),o.type=o.type.toUpperCase(),o.hasContent=!Gb.test(o.type),f=o.url.replace(Cb,""),o.hasContent?o.data&&o.processData&&0===(o.contentType||"").indexOf("application/x-www-form-urlencoded")&&(o.data=o.data.replace(Bb,"+")):(n=o.url.slice(f.length),o.data&&(f+=(vb.test(f)?"&":"?")+o.data,delete o.data),o.cache===!1&&(f=f.replace(Db,"$1"),n=(vb.test(f)?"&":"?")+"_="+ub++ +n),o.url=f+n),o.ifModified&&(r.lastModified[f]&&y.setRequestHeader("If-Modified-Since",r.lastModified[f]),r.etag[f]&&y.setRequestHeader("If-None-Match",r.etag[f])),(o.data&&o.hasContent&&o.contentType!==!1||c.contentType)&&y.setRequestHeader("Content-Type",o.contentType),y.setRequestHeader("Accept",o.dataTypes[0]&&o.accepts[o.dataTypes[0]]?o.accepts[o.dataTypes[0]]+("*"!==o.dataTypes[0]?", "+Kb+"; q=0.01":""):o.accepts["*"]);for(m in o.headers)y.setRequestHeader(m,o.headers[m]);if(o.beforeSend&&(o.beforeSend.call(p,y,o)===!1||k))return y.abort();if(x="abort",t.add(o.complete),y.done(o.success),y.fail(o.error),e=Nb(Jb,o,c,y)){if(y.readyState=1,l&&q.trigger("ajaxSend",[y,o]),k)return y;o.async&&o.timeout>0&&(i=a.setTimeout(function(){y.abort("timeout")},o.timeout));try{k=!1,e.send(v,A)}catch(z){if(k)throw z;A(-1,z)}}else A(-1,"No Transport");function A(b,c,d,h){var j,m,n,v,w,x=c;k||(k=!0,i&&a.clearTimeout(i),e=void 0,g=h||"",y.readyState=b>0?4:0,j=b>=200&&b<300||304===b,d&&(v=Pb(o,y,d)),v=Qb(o,v,y,j),j?(o.ifModified&&(w=y.getResponseHeader("Last-Modified"),w&&(r.lastModified[f]=w),w=y.getResponseHeader("etag"),w&&(r.etag[f]=w)),204===b||"HEAD"===o.type?x="nocontent":304===b?x="notmodified":(x=v.state,m=v.data,n=v.error,j=!n)):(n=x,!b&&x||(x="error",b<0&&(b=0))),y.status=b,y.statusText=(c||x)+"",j?s.resolveWith(p,[m,x,y]):s.rejectWith(p,[y,x,n]),y.statusCode(u),u=void 0,l&&q.trigger(j?"ajaxSuccess":"ajaxError",[y,o,j?m:n]),t.fireWith(p,[y,x]),l&&(q.trigger("ajaxComplete",[y,o]),--r.active||r.event.trigger("ajaxStop")))}return y},getJSON:function(a,b,c){return r.get(a,b,c,"json")},getScript:function(a,b){return r.get(a,void 0,b,"script")}}),r.each(["get","post"],function(a,b){r[b]=function(a,c,d,e){return r.isFunction(c)&&(e=e||d,d=c,c=void 0),r.ajax(r.extend({url:a,type:b,dataType:e,data:c,success:d},r.isPlainObject(a)&&a))}}),r._evalUrl=function(a){return r.ajax({url:a,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,"throws":!0})},r.fn.extend({wrapAll:function(a){var b;return this[0]&&(r.isFunction(a)&&(a=a.call(this[0])),b=r(a,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstElementChild)a=a.firstElementChild;return a}).append(this)),this},wrapInner:function(a){return r.isFunction(a)?this.each(function(b){r(this).wrapInner(a.call(this,b))}):this.each(function(){var b=r(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=r.isFunction(a);return this.each(function(c){r(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(a){return this.parent(a).not("body").each(function(){r(this).replaceWith(this.childNodes)}),this}}),r.expr.pseudos.hidden=function(a){return!r.expr.pseudos.visible(a)},r.expr.pseudos.visible=function(a){return!!(a.offsetWidth||a.offsetHeight||a.getClientRects().length)},r.ajaxSettings.xhr=function(){try{return new a.XMLHttpRequest}catch(b){}};var Rb={0:200,1223:204},Sb=r.ajaxSettings.xhr();o.cors=!!Sb&&"withCredentials"in Sb,o.ajax=Sb=!!Sb,r.ajaxTransport(function(b){var c,d;if(o.cors||Sb&&!b.crossDomain)return{send:function(e,f){var g,h=b.xhr();if(h.open(b.type,b.url,b.async,b.username,b.password),b.xhrFields)for(g in b.xhrFields)h[g]=b.xhrFields[g];b.mimeType&&h.overrideMimeType&&h.overrideMimeType(b.mimeType),b.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest");for(g in e)h.setRequestHeader(g,e[g]);c=function(a){return function(){c&&(c=d=h.onload=h.onerror=h.onabort=h.onreadystatechange=null,"abort"===a?h.abort():"error"===a?"number"!=typeof h.status?f(0,"error"):f(h.status,h.statusText):f(Rb[h.status]||h.status,h.statusText,"text"!==(h.responseType||"text")||"string"!=typeof h.responseText?{binary:h.response}:{text:h.responseText},h.getAllResponseHeaders()))}},h.onload=c(),d=h.onerror=c("error"),void 0!==h.onabort?h.onabort=d:h.onreadystatechange=function(){4===h.readyState&&a.setTimeout(function(){c&&d()})},c=c("abort");try{h.send(b.hasContent&&b.data||null)}catch(i){if(c)throw i}},abort:function(){c&&c()}}}),r.ajaxPrefilter(function(a){a.crossDomain&&(a.contents.script=!1)}),r.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(a){return r.globalEval(a),a}}}),r.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.crossDomain&&(a.type="GET")}),r.ajaxTransport("script",function(a){if(a.crossDomain){var b,c;return{send:function(e,f){b=r("