diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a0656931f0e52..c7d4ece081133 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -14,7 +14,7 @@ **Page to Update:** -http://kubernetes.io/... +https://kubernetes.io/... diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ffc221670e0d4..0bdacf9c04ab4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,6 @@ +>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +> For 1.10 Features: set Milestone to 1.10 and Base Branch to release-1.10 +>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > NOTE: After opening the PR, please *un-check and re-check* the ["Allow edits from maintainers"](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) box so that maintainers can work on your patch and speed up the review process. This is a temporary workaround to address a known issue with GitHub.> > > Please delete this note before submitting the pull request. diff --git a/.travis.yml b/.travis.yml index 9e19abba15190..bf3684ab3a0a6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,14 +7,18 @@ install: - export PATH=$GOPATH/bin:$PATH - mkdir -p $HOME/gopath/src/k8s.io - mv $TRAVIS_BUILD_DIR $HOME/gopath/src/k8s.io/website +- cd $HOME/gopath/src/k8s.io/website # (1) Fetch dependencies for us to run the tests in test/examples_test.go -- go get -t -v k8s.io/website/test +- pushd $GOPATH/src/k8s.io && git clone https://github.com/kubernetes/kubernetes && popd +- pushd $GOPATH/src/k8s.io/kubernetes && git checkout release-1.9 && popd -# Simplified deduplication of dependencies. +# (2) Simplified deduplication of dependencies. - cp -L -R $GOPATH/src/k8s.io/kubernetes/vendor/ $GOPATH/src/ - rm -r $GOPATH/src/k8s.io/kubernetes/vendor/ +- go get -t -v k8s.io/website/test + script: - go test -v k8s.io/website/test - ./verify-docs-format.sh diff --git a/Gemfile b/Gemfile index 409583e72a193..e07257c9127af 100644 --- a/Gemfile +++ b/Gemfile @@ -27,7 +27,7 @@ group :jekyll_plugins do gem "jekyll-github-metadata", "~> 2.2" gem "jekyll-optional-front-matter", "~> 0.1" gem "jekyll-readme-index", "0.0.3" - gem "jekyll-redirect-from", "~> 0.11" + gem "jekyll-redirect-from", "~> 0.13" gem "jekyll-relative-links", "~> 0.2" gem "jekyll-swiss", "~> 0.4" gem "jekyll-theme-architect", "0.0.3" diff --git a/Gemfile.lock b/Gemfile.lock index 577f4e69b245b..4af0fc40657e8 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -47,7 +47,7 @@ GEM jekyll-paginate (1.1.0) jekyll-readme-index (0.0.3) jekyll (~> 3.0) - jekyll-redirect-from (0.12.1) + jekyll-redirect-from (0.13.0) jekyll (~> 3.3) jekyll-relative-links (0.5.1) jekyll (~> 3.3) @@ -145,7 +145,7 @@ DEPENDENCIES jekyll-optional-front-matter (~> 0.1) jekyll-paginate (= 1.1.0) jekyll-readme-index (= 0.0.3) - jekyll-redirect-from (~> 0.11) + jekyll-redirect-from (~> 0.13) jekyll-relative-links (~> 0.2) jekyll-seo-tag jekyll-sitemap diff --git a/OWNERS b/OWNERS index 3431420ffd591..d78c7e41c9f1f 100644 --- a/OWNERS +++ b/OWNERS @@ -1,11 +1,21 @@ +# Reviewers can /lgtm /approve but not sufficient for auto-merge without an +# approver reviewers: -- tengqm -- zhangxiaoyu-zidif +- rajakavitha1 +- stewart-yu - xiangpengzhao +- zhangxiaoyu-zidif + +# Approvers have all the ability of reviewers but their /approve makes +# auto-merge happen if a /lgtm exists, or vice versa, or they can do both +# No need for approvers to also be listed as reviewers approvers: -- heckj -- a-mccarthy -- abiogenesis-now - bradamant3 +- bradtopol +- chenopis +- kbarnard10 +- mistyhacks - steveperry-53 +- tengqm - zacharysarah +- zparnold diff --git a/OWNERS_ALIASES b/OWNERS_ALIASES index 2ac8989ed273d..ecba525e656a9 100644 --- a/OWNERS_ALIASES +++ b/OWNERS_ALIASES @@ -87,11 +87,11 @@ aliases: - grodrigues3 - spxtr sig-docs: #Team: documentation; GH: sig-docs-pr-reviews - - a-mccarthy - - abiogenesis-now - bradamant3 - steveperry-53 - zacharysarah + - bradtopol + - heckj sig-federation: #Team: Federation; e.g. Federated Clusters - csbell sig-gcp: #Google Cloud Platform; GH: sig-gcp-pr-reviews @@ -149,9 +149,9 @@ aliases: - feiskyer - nebril sig-openstack: #GH: sig-openstack-pr-reviews - - idvoretskyi - - xsgordon - - NickrenREN + - hogepodge + - dklyle + - rjmorse sig-pm: #aka Product Management - apsinha - idvoretskyi @@ -203,4 +203,3 @@ aliases: - floreks sig-windows: - michmike - diff --git a/_config.yml b/_config.yml index 87698f6193e58..e4e02629cb76a 100644 --- a/_config.yml +++ b/_config.yml @@ -13,6 +13,7 @@ incremental: true safe: false lsi: false +latest: "v1.9" defaults: - scope: @@ -23,32 +24,32 @@ defaults: githubbranch: "master" docsbranch: "master" versions: + - fullversion: "v1.13.0" + version: "v1.13" + githubbranch: "v1.13.0" + docsbranch: "release-1.13" + url: https://kubernetes.io/docs/ + - fullversion: "v1.12.0" + version: "v1.12" + githubbranch: "v1.12.0" + docsbranch: "release-1.12" + url: https://v1-12.docs.kubernetes.io + - fullversion: "v1.11.0" + version: "v1.11" + githubbranch: "v1.11.0" + docsbranch: "release-1.11" + url: https://v1-11.docs.kubernetes.io + - fullversion: "v1.10.0" + version: "v1.10" + githubbranch: "v1.10.0" + docsbranch: "release-1.10" + url: https://v1-10.docs.kubernetes.io - fullversion: "v1.9.0" version: "v1.9" githubbranch: "v1.9.0" docsbranch: "release-1.9" - url: https://kubernetes.io - - fullversion: "v1.8.4" - version: "v1.8" - githubbranch: "v1.8.4" - docsbranch: "release-1.8" - url: https://v1-8.docs.kubernetes.io - - fullversion: "v1.7.6" - version: "v1.7" - githubbranch: "v1.7.6" - docsbranch: "release-1.7" - url: https://v1-7.docs.kubernetes.io - - fullversion: "v1.6.8" - version: "v1.6" - githubbranch: "v1.6.8" - docsbranch: "release-1.6" - url: https://v1-6.docs.kubernetes.io - - fullversion: "v1.5.7" - version: "v1.5" - githubbranch: "v1.5.7" - docsbranch: "release-1.5" - url: https://v1-5.docs.kubernetes.io - deprecated: false + url: https://v1-9.docs.kubernetes.io + deprecated: true currentUrl: https://kubernetes.io/docs/home/ nextUrl: http://kubernetes-io-vnext-staging.netlify.com/ - diff --git a/_data/concepts.yml b/_data/concepts.yml index 5b7e10662120c..bf6f8b53e842e 100644 --- a/_data/concepts.yml +++ b/_data/concepts.yml @@ -1,9 +1,11 @@ bigheader: "Concepts" abstract: "Detailed explanations of Kubernetes system concepts and abstractions." +landing_page: /docs/concepts/index/ toc: - docs/concepts/index.md - title: Overview + landing_page: /docs/concepts/overview/what-is-kubernetes/ section: - docs/concepts/overview/what-is-kubernetes.md - docs/concepts/overview/components.md @@ -23,12 +25,14 @@ toc: - docs/concepts/overview/object-management-kubectl/declarative-config.md - title: Kubernetes Architecture + landing_page: /docs/concepts/architecture/nodes/ section: - docs/concepts/architecture/nodes.md - docs/concepts/architecture/master-node-communication.md - docs/concepts/architecture/cloud-controller.md - title: Extending Kubernetes + landing_page: /docs/concepts/api-extension/custom-resources/ section: - docs/concepts/overview/extending.md - title: Extending the Kubernetes API @@ -39,16 +43,17 @@ toc: section: - docs/concepts/cluster-administration/network-plugins.md - docs/concepts/cluster-administration/device-plugins.md - - docs/concepts/cluster-administration/sysctl-cluster.md - docs/concepts/service-catalog/index.md - title: Containers + landing_page: /docs/concepts/containers/images/ section: - docs/concepts/containers/images.md - docs/concepts/containers/container-environment-variables.md - docs/concepts/containers/container-lifecycle-hooks.md - title: Workloads + landing_page: /docs/concepts/workloads/pods/pod-overview/ section: - title: Pods section: @@ -70,6 +75,7 @@ toc: - docs/concepts/workloads/controllers/cron-jobs.md - title: Configuration + landing_page: /docs/concepts/configuration/overview/ section: - docs/concepts/configuration/overview.md - docs/concepts/configuration/manage-compute-resources-container.md @@ -80,6 +86,7 @@ toc: - docs/concepts/configuration/pod-priority-preemption.md - title: Services, Load Balancing, and Networking + landing_page: /docs/concepts/services-networking/service/ section: - docs/concepts/services-networking/service.md - docs/concepts/services-networking/dns-pod-service.md @@ -89,6 +96,7 @@ toc: - docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases.md - title: Storage + landing_page: /docs/concepts/storage/volumes/ section: - docs/concepts/storage/volumes.md - docs/concepts/storage/persistent-volumes.md @@ -96,6 +104,7 @@ toc: - docs/concepts/storage/dynamic-provisioning.md - title: Cluster Administration + landing_page: /docs/concepts/cluster-administration/cluster-administration-overview/ section: - docs/concepts/cluster-administration/cluster-administration-overview.md - docs/concepts/cluster-administration/certificates.md @@ -116,5 +125,3 @@ toc: section: - docs/concepts/policy/resource-quotas.md - docs/concepts/policy/pod-security-policy.md - - diff --git a/_data/docs-home.yml b/_data/docs-home.yml index c861e991f662c..2458cf4ec5b33 100644 --- a/_data/docs-home.yml +++ b/_data/docs-home.yml @@ -1,19 +1,16 @@ -bigheader: "Documentation Home" +bigheader: "About" abstract: "Documentation for using and learning about Kubernetes." toc: - docs/home/index.md -- docs/home/supported-doc-versions.md -- title: Release Notes - path: https://git.k8s.io/kubernetes/CHANGELOG.md -- title: Release Roadmap - path: https://github.com/kubernetes/kubernetes/milestones/ - -- docs/tasks/debug-application-cluster/troubleshooting.md +- title: Supported Doc Versions + path: /docs/home/supported-doc-versions/ - title: Contributing to the Kubernetes Docs + landing_page: /editdocs/ section: - editdocs.md + - docs/home/contribute/participating.md - docs/home/contribute/create-pull-request.md - docs/home/contribute/write-new-topic.md - docs/home/contribute/stage-documentation-changes.md @@ -21,6 +18,7 @@ toc: - docs/home/contribute/review-issues.md - docs/home/contribute/style-guide.md - docs/home/contribute/includes.md + - docs/home/contribute/localization.md - title: Updating Automatically Generated Reference Pages section: diff --git a/_data/glossary/annotation.yaml b/_data/glossary/annotation.yaml index f680440b08c48..7d46eb232adba 100644 --- a/_data/glossary/annotation.yaml +++ b/_data/glossary/annotation.yaml @@ -1,6 +1,6 @@ id: annotation name: Annotation -full-link: docs/concepts/overview/working-with-objects/annotations +full-link: /docs/concepts/overview/working-with-objects/annotations tags: - fundamental short-description: > diff --git a/_data/glossary/certificate.yaml b/_data/glossary/certificate.yaml new file mode 100644 index 0000000000000..856c254d50e09 --- /dev/null +++ b/_data/glossary/certificate.yaml @@ -0,0 +1,11 @@ +id: certificate +name: Certificate +full-link: /docs/tasks/tls/managing-tls-in-a-cluster/ +tags: +- security +short-description: > + A cryptographically secure file used to validate access to the Kubernetes cluster. +long-description: > + Certificates enable applications within a Kubernetes + cluster to access the Kubernetes API securely. Certificates validate that + clients are allowed to access the API. diff --git a/_data/glossary/cloud-controller-manager.yml b/_data/glossary/cloud-controller-manager.yml new file mode 100644 index 0000000000000..dd819c42147d1 --- /dev/null +++ b/_data/glossary/cloud-controller-manager.yml @@ -0,0 +1,13 @@ +id: cloud-controller-manager +name: Cloud Controller Manager +full-link: https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/ +tags: +- core-object +- architecture +- operation +short-description: > + Cloud Controller Manager is an alpha feature in 1.8. In upcoming releases it will be the preferred way to integrate Kubernetes with any cloud. +long-description: > + Kubernetes v1.6 contains a new binary called cloud-controller-manager. cloud-controller-manager is a daemon that embeds cloud-specific control loops. + These cloud-specific control loops were originally in the kube-controller-manager. Since cloud providers develop and release at a different pace compared to the Kubernetes + project, abstracting the provider-specific code to the cloud-controller-manager binary allows cloud vendors to evolve independently from the core Kubernetes code. diff --git a/_data/glossary/cloud-provider.yaml b/_data/glossary/cloud-provider.yaml new file mode 100644 index 0000000000000..82ba2f4c22635 --- /dev/null +++ b/_data/glossary/cloud-provider.yaml @@ -0,0 +1,10 @@ +id: cloud-provider +name: Cloud Provider +full-link: /docs/concepts/cluster-administration/cloud-providers +tags: +- community +short-description: > + Cloud provider is a company that offers cloud computing platform that can run Kubernetes clusters. +long-description: > + Cloud providers or sometime called Cloud Service Provider (CSPs) provides cloud computing platforms. They may offer services such as Infrastructure as a Service (IaaS) or Platform as a Service (PaaS). Cloud providers host the Kubernetes cluster and also provide services that interact with the cluster, such as Load Balancers, Storage Classes etc. + diff --git a/_data/glossary/code-contributor.yaml b/_data/glossary/code-contributor.yaml index 9fa8fbe82c8d9..f31b196b5c162 100644 --- a/_data/glossary/code-contributor.yaml +++ b/_data/glossary/code-contributor.yaml @@ -1,5 +1,6 @@ id: code-contributor name: Code Contributor +full-link: /docs/imported/community/devel/ aka: - Community Developer tags: diff --git a/_data/glossary/container-env-variables.yaml b/_data/glossary/container-env-variables.yaml new file mode 100644 index 0000000000000..ea1fbd2260f7f --- /dev/null +++ b/_data/glossary/container-env-variables.yaml @@ -0,0 +1,9 @@ +id: container-env-variables +name: Container Environment Variables +full-link: /docs/concepts/containers/container-environment-variables.md +tags: +- fundamental +short-description: > + Container environment variables are name/value pairs that provide useful information into containers running in a Pod. +long-description: > + Container environment variables provide information that is required by the running containerized applications along with information about important resources to the [Containers] {% glossary_tooltip text="Containers" term_id="container" %}. For example, file system, information about the container itself and other cluster resources such as service endpoints, etc. diff --git a/_data/glossary/customresourcedefinition.yaml b/_data/glossary/customresourcedefinition.yaml new file mode 100644 index 0000000000000..8c3bd0a82a08d --- /dev/null +++ b/_data/glossary/customresourcedefinition.yaml @@ -0,0 +1,14 @@ +id: CustomResourceDefinition +name: CustomResourceDefinition +aka: +- CRD +- Formerly Known as ThirdPartyResources (TPR) +tags: +- fundamental +- operation +- extension +full-link: docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/ +short-description: > + Custom code that defines a resource to add to your Kubernetes API server without building a complete custom server. +long-description: > + Custom Resource Definitions let you extend the Kubernetes API for your environment if the publicly supported API resources can't meet your needs. diff --git a/_data/glossary/daemonset.yaml b/_data/glossary/daemonset.yaml index 09142d4fd6ce0..cb3374037dbd7 100644 --- a/_data/glossary/daemonset.yaml +++ b/_data/glossary/daemonset.yaml @@ -3,8 +3,9 @@ name: DaemonSet full-link: /docs/concepts/workloads/controllers/daemonset tags: - fundamental +- core-object - workload short-description: > - Ensures a copy of a {% glossary_tooltip term_id="pod" %} is running across a set of nodes in a {% glossary_tooltip term_id="cluster" %}. + Ensures a copy of a {% glossary_tooltip text="Pod" term_id="pod" %} is running across a set of nodes in a {% glossary_tooltip text="cluster" term_id="cluster" %}. long-description: > Used to deploy system daemons such as log collectors and monitoring agents that typically must run on every {% glossary_tooltip term_id="node" %}. diff --git a/_data/glossary/docker.yaml b/_data/glossary/docker.yaml new file mode 100644 index 0000000000000..d055a99f42b45 --- /dev/null +++ b/_data/glossary/docker.yaml @@ -0,0 +1,9 @@ +id: docker +name: docker +full-link: /docs/reference/kubectl/docker-cli-to-kubectl/ +tags: +- fundamental +short-description: > + Docker is a software technology providing operating-system-level virtualization also known as containers. +long-description: > + Docker uses the resource isolation features of the Linux kernel such as cgroups and kernel namespaces, and a union-capable file system such as OverlayFS and others to allow independent "containers" to run within a single Linux instance, avoiding the overhead of starting and maintaining virtual machines (VMs). diff --git a/_data/glossary/dynamic-volume-provisioning.yaml b/_data/glossary/dynamic-volume-provisioning.yaml new file mode 100644 index 0000000000000..56fb7a88b9407 --- /dev/null +++ b/_data/glossary/dynamic-volume-provisioning.yaml @@ -0,0 +1,11 @@ +id: dynamicvolumeprovisioning +name: Dynamic Volume Provisioning +full-link: /docs/concepts/storage/dynamic-provisioning +tags: +- core-object +- storage +short-description: > + Allows users to request automatic creation of storage {% glossary_tooltip text="Volumes" term_id="volume" %}. +long-description: > + Dynamic provisioning eliminates the need for cluster administrators to pre-provision storage. Instead, it automatically provisions storage by user request. + Dynamic volume provisioning is based on an API object, {% glossary_tooltip text="StorageClass" term_id="storage-class" %}, referring to a {% glossary_tooltip text="Volume Plugin" term_id="volume-plugin" %} that provisions a {% glossary_tooltip text="Volume" term_id="volume" %} and the set of parameters to pass to the Volume Plugin. diff --git a/_data/glossary/init-container.yaml b/_data/glossary/init-container.yaml new file mode 100644 index 0000000000000..9e6904739e346 --- /dev/null +++ b/_data/glossary/init-container.yaml @@ -0,0 +1,8 @@ +id: init-container +name: Init Container +tags: +- fundamental +short-description: > + One or more initialization containers that must run to completion before any app containers run. +long-description: > + Initialization (init) containers are like regular app containers, with one difference: init containers must run to completion before any app containers can start. Init containers run in series: each init container must run to completion before the next init container begins. diff --git a/_data/glossary/job.yaml b/_data/glossary/job.yaml index c868a6894169f..ec32a36943c5a 100644 --- a/_data/glossary/job.yaml +++ b/_data/glossary/job.yaml @@ -2,7 +2,9 @@ id: job name: Job full-link: /docs/concepts/workloads/controllers/jobs-run-to-completion tags: +- fundamental - core-object +- workload short-description: > A finite or batch task that runs to completion. long-description: > diff --git a/_data/glossary/kube-proxy.yaml b/_data/glossary/kube-proxy.yaml new file mode 100644 index 0000000000000..b5dc358ffe961 --- /dev/null +++ b/_data/glossary/kube-proxy.yaml @@ -0,0 +1,10 @@ +id: kube proxy +name: kube-proxy +full-link: /docs/reference/generated/kube-proxy +tags: +- fundamental +- core-object +short-description: > + `kube-proxy` is a network proxy that runs on each node in the cluster. +long-description: > + `kube-proxy` is responsible for request forwarding. `kube-proxy` allows TCP and UDP stream forwarding or round robin TCP and UDP forwarding across a set of backend functions. diff --git a/_data/glossary/kubelet.yaml b/_data/glossary/kubelet.yaml index 4728339907d2d..ed69870cbd3a4 100644 --- a/_data/glossary/kubelet.yaml +++ b/_data/glossary/kubelet.yaml @@ -1,6 +1,6 @@ id: kubelet name: Kubelet -full-link: docs/reference/generated/kubelet +full-link: /docs/reference/generated/kubelet tags: - fundamental - core-object diff --git a/_data/glossary/labels.yaml b/_data/glossary/label.yaml similarity index 100% rename from _data/glossary/labels.yaml rename to _data/glossary/label.yaml diff --git a/_data/glossary/namespace.yaml b/_data/glossary/namespace.yaml index be733fc35d2c4..2d976fc881fdf 100644 --- a/_data/glossary/namespace.yaml +++ b/_data/glossary/namespace.yaml @@ -4,7 +4,7 @@ full-link: /docs/concepts/overview/working-with-objects/namespaces tags: - fundamental short-description: > - An abstraction used by Kubernetes to support multiple virtual clusters on the same physical {% glossary_tooltip term_id="cluster" %}. + An abstraction used by Kubernetes to support multiple virtual clusters on the same physical {% glossary_tooltip text="cluster" term_id="cluster" %}. long-description: > Namespaces are used to organize objects in a cluster and provide a way to divide cluster resources. Names of resources need to be unique within a namespace, but not across namespaces. diff --git a/_data/glossary/persistent-volume.yaml b/_data/glossary/persistent-volume.yaml index 1f0fe7b52899a..00f70a236601f 100644 --- a/_data/glossary/persistent-volume.yaml +++ b/_data/glossary/persistent-volume.yaml @@ -10,8 +10,8 @@ tags: - core-object - storage short-description: > - An API object that represents a piece of storage in the cluster. Available as a general, pluggable resource that persists beyond the lifecycle of any individual {% glossary_tooltip term_id="pod" %}. + An API object that represents a piece of storage in the cluster. Available as a general, pluggable resource that persists beyond the lifecycle of any individual {% glossary_tooltip text="Pod" term_id="pod" %}. long-description: | PersistentVolumes (PVs) provide an API that abstracts details of how storage is provided from how it is consumed. - PVs are used directly in scenarios where storage can be be created ahead of time (static provisioning). + PVs are used directly in scenarios where storage can be created ahead of time (static provisioning). For scenarios that require on-demand storage (dynamic provisioning), PersistentVolumeClaims (PVCs) are used instead. diff --git a/_data/glossary/podpreset.yaml b/_data/glossary/podpreset.yaml new file mode 100644 index 0000000000000..57715327c8a3a --- /dev/null +++ b/_data/glossary/podpreset.yaml @@ -0,0 +1,12 @@ +id: podpreset +name: PodPreset +tags: +- operation +short-description: > + An API object that injects information such as secrets, volume mounts, + and environment variables into pods at creation time. +long-description: > + This object chooses the pods to inject information into using + standard selectors. This allows the podspec definitions to be + nonspecific, decoupling the podspec from environment specific + configuration. diff --git a/_data/glossary/replica-set.yml b/_data/glossary/replica-set.yml index 74d987b588654..e239a438b721c 100644 --- a/_data/glossary/replica-set.yml +++ b/_data/glossary/replica-set.yml @@ -4,8 +4,9 @@ full-link: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ related: - replication-controller tags: +- fundamental - core-object -- architecture +- workload short-description: > ReplicaSet is the next-generation Replication Controller. long-description: > diff --git a/_data/glossary/replication-controller.yaml b/_data/glossary/replication-controller.yaml index 6009b49c8b7aa..04b071a8e480f 100644 --- a/_data/glossary/replication-controller.yaml +++ b/_data/glossary/replication-controller.yaml @@ -1,7 +1,8 @@ id: replication-controller name: Replication Controller tags: -- fundamental +- workload +- core-object short-description: > Kubernetes service that ensures a specific number of instances of a pod are always running. long-description: > diff --git a/_data/glossary/selector.yaml b/_data/glossary/selector.yaml new file mode 100644 index 0000000000000..e8e7a7b72d52d --- /dev/null +++ b/_data/glossary/selector.yaml @@ -0,0 +1,13 @@ +id: selector +name: Selector +full-link: /docs/concepts/overview/working-with-objects/labels/ +related: +- label +tags: +- fundamental +short-description: > + Allows users to filter a list of resources based on labels. +long-description: > + Selectors are applied when querying lists of resources to filter + them by {% glossary_tooltip text="Labels" term_id="label" + %}. diff --git a/_data/glossary/service-account.yaml b/_data/glossary/service-account.yaml index 2684bc5e93097..a7fcf3ec0534c 100644 --- a/_data/glossary/service-account.yaml +++ b/_data/glossary/service-account.yaml @@ -5,6 +5,6 @@ tags: - fundamental - core-object short-description: > - Provides an identity for processes that run in a Pod {% glossary_tooltip text="Pods" term_id="pod" %}. + Provides an identity for processes that run in a {% glossary_tooltip text="Pod" term_id="pod" %}. long-description: > When processes inside Pods access the cluster, they are authenticated by the API server as a particular service account, for example, `default`. When you create a Pod, if you do not specify a service account, it is automatically assigned the default service account in the same namespace {% glossary_tooltip text="Namespace" term_id="namespace" %}. diff --git a/_data/glossary/statefulset.yml b/_data/glossary/statefulset.yml index 4fdbd5ce12c6f..542523f5df167 100644 --- a/_data/glossary/statefulset.yml +++ b/_data/glossary/statefulset.yml @@ -5,6 +5,7 @@ related: - deployment - pod tags: +- fundamental - core-object - workload - storage diff --git a/_data/glossary/storage-class.yaml b/_data/glossary/storage-class.yaml new file mode 100644 index 0000000000000..db36fca77609f --- /dev/null +++ b/_data/glossary/storage-class.yaml @@ -0,0 +1,11 @@ +id: storageclass +name: Storage Class +full-link: /docs/concepts/storage/storage-classes +tags: +- core-object +- storage +short-description: > + A StorageClass provides a way for administrators to describe different available storage types. +long-description: > + StorageClasses can map to quality-of-service levels, backup policies, or to arbitrary policies determined by cluster administrators. + Each StorageClass contains the fields `provisioner`, `parameters`, and `reclaimPolicy`, which are used when a {% glossary_tooltip text="Persistent Volume" term_id="persistent-volume" %} belonging to the class needs to be dynamically provisioned. Users can request a particular class using the name of a StorageClass object. diff --git a/_data/glossary/volume-plugin.yaml b/_data/glossary/volume-plugin.yaml new file mode 100644 index 0000000000000..b3ccdaec8d4bc --- /dev/null +++ b/_data/glossary/volume-plugin.yaml @@ -0,0 +1,11 @@ +id: volumeplugin +name: Volume Plugin +tags: +- core-object +- storage +short-description: > + A Volume Plugin enables integration of storage within a {% glossary_tooltip text="Pod" term_id="pod" %}. +long-description: > + A Volume Plugin lets you attach and mount storage volumes for use by a {% glossary_tooltip text="Pod" term_id="pod" %}. + Volume plugins can be _in tree_ or _out of tree_. _In tree_ plugins are part of the Kubernetes code repository and follow its release cycle. _Out of tree_ plugins are developed independently. + diff --git a/_data/reference.yml b/_data/reference.yml index 2afece5532bbe..879164011354a 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -1,10 +1,14 @@ -bigheader: "Reference Documentation" +bigheader: "Reference" abstract: "Design docs, concept definitions, and references for APIs and CLIs." +landing_page: /docs/reference/index/ toc: - docs/reference/index.md -- docs/reference/glossary.md + +- title: Standardized Glossary + path: /docs/reference/glossary/ - title: Using the API + landing_page: /docs/reference/api-overview/ section: - docs/reference/api-overview.md - docs/reference/client-libraries.md @@ -28,6 +32,7 @@ toc: - docs/reference/workloads-18-19.md - title: API Reference + landing_page: /docs/api-reference/v1.8/ section: - title: v1.9 path: /docs/reference/generated/kubernetes-api/v1.9/ @@ -40,6 +45,7 @@ toc: path: https://git.k8s.io/kubernetes/api/swagger-spec/ - title: Federation API + landing_page: /docs/reference/federation/v1/operations/ section: - docs/reference/generated/federation/v1/operations.html - docs/reference/generated/federation/v1/definitions.html @@ -47,6 +53,7 @@ toc: - docs/reference/generated/federation/extensions/v1beta1/definitions.html - title: kubectl CLI + landing_page: /docs/user-guide/kubectl-overview/ section: - docs/reference/kubectl/overview.md - docs/reference/generated/kubectl/kubectl.md @@ -58,6 +65,7 @@ toc: - docs/reference/kubectl/cheatsheet.md - title: Setup Tools Reference + landing_page: /docs/reference/setup-tools/kubeadm/kubeadm/ section: - title: Kubeadm section: @@ -81,6 +89,7 @@ toc: - docs/reference/generated/kubefed_version.md - title: Command-line Tools Reference + landing_page: /docs/admin/kubelet/ section: - docs/reference/feature-gates.md - docs/reference/generated/kubelet.md @@ -94,21 +103,8 @@ toc: - docs/reference/generated/federation-apiserver.md - docs/reference/generated/federation-controller-manager.md -- title: Kubernetes Design Docs - section: - - title: Kubernetes Architecture - path: https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md - - title: Kubernetes Design Overview - path: https://github.com/kubernetes/kubernetes/tree/release-1.6/docs/design - - title: Kubernetes Identity and Access Management - path: https://git.k8s.io/community/contributors/design-proposals/auth/access.md - - docs/admin/ovs-networking.md - - title: Security Contexts - path: https://git.k8s.io/community/contributors/design-proposals/auth/security_context.md - - title: Security in Kubernetes - path: https://git.k8s.io/community/contributors/design-proposals/auth/security.md - - title: Kubernetes Issues and Security + landing_page: https://github.com/kubernetes/kubernetes/issues/ section: - title: Kubernetes Issue Tracker on GitHub path: https://github.com/kubernetes/kubernetes/issues/ diff --git a/_data/setup.yml b/_data/setup.yml index f91170ab95f40..ec85fcd791aff 100644 --- a/_data/setup.yml +++ b/_data/setup.yml @@ -1,5 +1,6 @@ bigheader: "Setup" abstract: "Instructions for setting up a Kubernetes cluster." +landing_page: /docs/setup/index/ toc: - docs/setup/index.md - docs/setup/pick-right-solution.md @@ -11,6 +12,7 @@ toc: - docs/setup/building-from-source.md - title: Independent Solutions + landing_page: /docs/getting-started-guides/minikube/ section: - docs/getting-started-guides/minikube.md @@ -25,6 +27,7 @@ toc: - docs/getting-started-guides/alternatives.md - title: Hosted Solutions + landing_page: /docs/setup/pick-right-solution/#hosted-solutions section: - title: Running Kubernetes on Google Kubernetes Engine path: https://cloud.google.com/kubernetes-engine/docs/before-you-begin/ @@ -34,18 +37,19 @@ toc: path: https://console.bluemix.net/docs/containers/container_index.html - title: Turn-key Cloud Solutions + landing_page: /docs/getting-started-guides/alibaba-cloud/ section: - - docs/getting-started-guides/gce.md + - docs/getting-started-guides/alibaba-cloud.md - docs/getting-started-guides/aws.md - docs/getting-started-guides/azure.md - - docs/getting-started-guides/alibaba-cloud.md - docs/getting-started-guides/clc.md + - docs/getting-started-guides/gce.md - title: Running Kubernetes on IBM Cloud path: https://github.com/patrocinio/kubernetes-softlayer - docs/getting-started-guides/stackpoint.md - title: Custom Solutions - + landing_page: /docs/getting-started-guides/coreos/index/ section: - title: Custom Cloud Solutions section: @@ -55,29 +59,19 @@ toc: - docs/getting-started-guides/kubespray.md - docs/getting-started-guides/running-cloud-controller.md - - title: On-Premise VMs + - title: On-Premises VMs section: - docs/getting-started-guides/coreos/index.md - docs/getting-started-guides/cloudstack.md - - docs/getting-started-guides/vsphere.md + - title: VMware vSphere + path: https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/ - docs/getting-started-guides/dcos.md - docs/getting-started-guides/ovirt.md - - title: rkt - section: - - docs/getting-started-guides/rkt/index.md - - docs/getting-started-guides/rkt/notes.md - - - docs/getting-started-guides/mesos/index.md - - docs/getting-started-guides/mesos-docker.md - - title: Bare Metal section: - - docs/getting-started-guides/coreos/bare_metal_offline.md - - docs/getting-started-guides/fedora/fedora_ansible_config.md - docs/getting-started-guides/fedora/fedora_manual_config.md - docs/getting-started-guides/fedora/flannel_multi_node_cluster.md - - docs/getting-started-guides/centos/centos_manual_config.md - docs/getting-started-guides/coreos/index.md - docs/getting-started-guides/ubuntu/index.md @@ -99,11 +93,32 @@ toc: - docs/getting-started-guides/ubuntu/glossary.md - docs/getting-started-guides/ubuntu/local.md - docs/getting-started-guides/ubuntu/logging.md - + - docs/getting-started-guides/ubuntu/rancher.md - docs/getting-started-guides/windows/index.md - docs/admin/node-conformance.md +- title: User Journeys + landing_page: /docs/home/ + section: + + - title: Application Developer + section: + - docs/user-journeys/users/application-developer/foundational.md + - docs/user-journeys/users/application-developer/intermediate.md + - docs/user-journeys/users/application-developer/advanced.md + - title: Cluster Operator + section: + - docs/user-journeys/users/cluster-operator/foundational.md + - docs/user-journeys/users/cluster-operator/intermediate.md + + - title: Docs Contributor + path: /docs/home/?path=contributors&persona=docs-contributor&level=foundational + - title: Code Contributor + path: /docs/home/?path=contributors&persona=code-contributor&level=foundational + - title: Community Contributor + path: /docs/home/?path=contributors&persona=community-contributor&level=foundational + - title: Installing Addons path: /docs/concepts/cluster-administration/addons/ @@ -117,4 +132,4 @@ toc: path: /docs/admin/multiple-zones/ - title: Building High-Availability Clusters - path: /docs/admin/high-availability/ + path: /docs/admin/high-availability/building/ diff --git a/_data/tasks.yml b/_data/tasks.yml index 2220978f8d23a..d7c03e36ee370 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -1,15 +1,18 @@ bigheader: "Tasks" abstract: "Step-by-step instructions for performing operations with Kubernetes." +landing_page: /docs/tasks/index/ toc: - docs/tasks/index.md - title: Install Tools + landing_page: /docs/tasks/tools/install-kubectl/ section: - docs/tasks/tools/install-kubectl.md - docs/tasks/tools/install-minikube.md - docs/setup/independent/install-kubeadm.md - title: Configure Pods and Containers + landing_page: /docs/tasks/configure-pod-container/configure-pod-initialization/ section: - docs/tasks/configure-pod-container/assign-memory-resource.md - docs/tasks/configure-pod-container/assign-cpu-resource.md @@ -32,6 +35,7 @@ toc: - docs/tools/kompose/user-guide.md - title: Inject Data Into Applications + landing_page: /docs/tasks/inject-data-application/define-environment-variable-container/ section: - docs/tasks/inject-data-application/define-command-argument-container.md - docs/tasks/inject-data-application/define-environment-variable-container.md @@ -41,6 +45,7 @@ toc: - docs/tasks/inject-data-application/podpreset.md - title: Run Applications + landing_page: /docs/tasks/run-application/run-stateless-application-deployment/ section: - docs/tasks/run-application/run-stateless-application-deployment.md - docs/tasks/run-application/run-single-instance-stateful-application.md @@ -56,12 +61,14 @@ toc: - docs/tasks/run-application/configure-pdb.md - title: Run Jobs + landing_page: /docs/tasks/job/parallel-processing-expansion/ section: - docs/tasks/job/parallel-processing-expansion.md - docs/tasks/job/coarse-parallel-processing-work-queue/index.md - docs/tasks/job/fine-parallel-processing-work-queue/index.md - title: Access Applications in a Cluster + landing_page: /docs/tasks/access-application-cluster/web-ui-dashboard/ section: - docs/tasks/access-application-cluster/web-ui-dashboard.md - docs/tasks/access-application-cluster/access-cluster.md @@ -78,6 +85,7 @@ toc: path: https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/cluster-dns - title: Monitor, Log, and Debug + landing_page: /docs/tasks/debug-application-cluster/resource-usage-monitoring/ section: - docs/tasks/debug-application-cluster/core-metrics-pipeline.md - docs/tasks/debug-application-cluster/resource-usage-monitoring.md @@ -100,6 +108,7 @@ toc: path: https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/explorer - title: Extend Kubernetes + landing_page: /docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/ section: - docs/tasks/access-kubernetes-api/http-proxy-access-api.md - docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions.md @@ -111,11 +120,13 @@ toc: - docs/tasks/service-catalog/install-service-catalog-using-sc.md - title: TLS + landing_page: /docs/tasks/tls/managing-tls-in-a-cluster/ section: - docs/tasks/tls/managing-tls-in-a-cluster.md - docs/tasks/tls/certificate-rotation.md - title: Administer a Cluster + landing_page: /docs/tasks/administer-cluster/memory-default-namespace/ section: - title: Manage Memory, CPU, and API Resources section: @@ -132,6 +143,7 @@ toc: - docs/tasks/administer-cluster/access-cluster-api.md - docs/tasks/administer-cluster/access-cluster-services.md - docs/tasks/administer-cluster/securing-a-cluster.md + - docs/tasks/administer-cluster/sysctl-cluster.md - docs/tasks/administer-cluster/encrypt-data.md - docs/tasks/administer-cluster/configure-upgrade-etcd.md - docs/tasks/administer-cluster/static-pod.md @@ -140,6 +152,7 @@ toc: - docs/tasks/administer-cluster/kubeadm-upgrade-1-7.md - docs/tasks/administer-cluster/kubeadm-upgrade-1-8.md - docs/tasks/administer-cluster/kubeadm-upgrade-1-9.md + - docs/tasks/administer-cluster/kubeadm-upgrade-ha.md - docs/tasks/administer-cluster/namespaces.md - docs/tasks/administer-cluster/namespaces-walkthrough.md - docs/tasks/administer-cluster/dns-horizontal-autoscaling.md @@ -169,9 +182,11 @@ toc: - docs/tasks/administer-cluster/configure-multiple-schedulers.md - docs/tasks/administer-cluster/ip-masq-agent.md - docs/tasks/administer-cluster/dns-custom-nameservers.md + - docs/tasks/administer-cluster/dns-debugging-resolution.md - docs/tasks/administer-cluster/pvc-protection.md - title: Federation - Run an App on Multiple Clusters + landing_page: /docs/tasks/federation/set-up-cluster-federation-kubefed/ section: - docs/tasks/federation/federation-service-discovery.md - docs/tasks/federation/set-up-cluster-federation-kubefed.md @@ -190,18 +205,19 @@ toc: - docs/tasks/administer-federation/secret.md - title: Manage Cluster Daemons + landing_page: /docs/tasks/manage-daemon/update-daemon-set/ section: - docs/tasks/manage-daemon/update-daemon-set.md - docs/tasks/manage-daemon/rollback-daemon-set.md - title: Manage GPUs - section: - - docs/tasks/manage-gpus/scheduling-gpus.md + path: /docs/tasks/manage-gpus/scheduling-gpus/ - title: Manage HugePages - section: - - docs/tasks/manage-hugepages/scheduling-hugepages.md + path: /docs/tasks/manage-hugepages/scheduling-hugepages/ - title: Extend kubectl with plugins - section: - - docs/tasks/extend-kubectl/kubectl-plugins.md + path: /docs/tasks/extend-kubectl/kubectl-plugins/ + +- title: Troubleshooting + path: /docs/tasks/debug-application-cluster/troubleshooting/ diff --git a/_data/tutorials.yml b/_data/tutorials.yml index 32e2b565ed7fc..88217396f1ea0 100644 --- a/_data/tutorials.yml +++ b/_data/tutorials.yml @@ -1,8 +1,10 @@ bigheader: "Tutorials" abstract: "Detailed walkthroughs of common Kubernetes operations and workflows." +landing_page: /docs/tutorials/index/ toc: - docs/tutorials/index.md - title: Kubernetes Basics + landing_page: /docs/tutorials/kubernetes-basics/index/ section: - docs/tutorials/kubernetes-basics/index.html - title: 1. Create a Cluster @@ -30,24 +32,32 @@ toc: - docs/tutorials/kubernetes-basics/update-intro.html - docs/tutorials/kubernetes-basics/update-interactive.html - title: Online Training Courses + landing_page: /docs/tutorials/online-training/overview/ section: + - docs/tutorials/online-training/overview.md - title: Scalable Microservices with Kubernetes (Udacity) path: https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615 - title: Introduction to Kubernetes (edX) path: https://www.edx.org/course/introduction-kubernetes-linuxfoundationx-lfs158x# -- docs/tutorials/stateless-application/hello-minikube.md -- docs/user-guide/walkthrough/index.md -- docs/user-guide/walkthrough/k8s201.md +- title: Hello Minikube + path: /docs/tutorials/stateless-application/hello-minikube/ +- title: Kubernetes 101 + path: /docs/user-guide/walkthrough/ +- title: Kubernetes 201 + path: /docs/user-guide/walkthrough/k8s201/ - title: Configuration + landing_page: /docs/tutorials/configuration/configure-redis-using-configmap/ section: - docs/tutorials/configuration/configure-redis-using-configmap.md - title: Stateless Applications + landing_page: /docs/tutorials/stateless-application/guestbook/ section: - docs/tasks/run-application/run-stateless-application-deployment.md - docs/tutorials/stateless-application/guestbook.md - docs/tasks/access-application-cluster/service-access-application-cluster.md - docs/tutorials/stateless-application/expose-external-ip-address.md - title: Stateful Applications + landing_page: /docs/tutorials/stateful-application/basic-stateful-set/ section: - docs/tutorials/stateful-application/basic-stateful-set.md - docs/tasks/run-application/run-single-instance-stateful-application.md @@ -56,8 +66,10 @@ toc: - docs/tutorials/stateful-application/cassandra.md - docs/tutorials/stateful-application/zookeeper.md - title: Clusters + landing_page: /docs/tutorials/clusters/apparmor/ section: - docs/tutorials/clusters/apparmor.md - title: Services + landing_page: /docs/tutorials/services/source-ip/ section: - docs/tutorials/services/source-ip.md diff --git a/_data/user-personas/contributors/code-contributor.yaml b/_data/user-personas/contributors/code-contributor.yaml new file mode 100644 index 0000000000000..b21b8841a101a --- /dev/null +++ b/_data/user-personas/contributors/code-contributor.yaml @@ -0,0 +1,19 @@ +id: code-contributor +name: Code Contributor +glossary_id: code-contributor +index: 0 +foundational: + - label: "Read the Developer Guide" + icon: fa-book + url: "/docs/imported/community/devel/" +intermediate: + - label: "Learn about the Kubernetes Enhancement Proposal (KEP) process" + icon: fa-upload + url: "/docs/imported/community/keps/" + - label: "Understand the API conventions" + icon: fa-map-o + url: "https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md" +advanced: + - label: "Learn about the release process" + icon: fa-code-fork + url: "https://github.com/kubernetes/release/blob/master/README.md" diff --git a/_data/user-personas/contributors/community-contributor.yaml b/_data/user-personas/contributors/community-contributor.yaml new file mode 100644 index 0000000000000..30194dc553756 --- /dev/null +++ b/_data/user-personas/contributors/community-contributor.yaml @@ -0,0 +1,19 @@ +id: community-contributor +name: Community Contributor +short_desc: A person who works to build the Kubernetes community (e.g. by organizing meetups). +index: 1 +foundational: + - label: "Contribute to the Kubernetes OSS project" + icon: fa-users + url: "/docs/imported/community/guide/" + - label: "Find out about mentoring initiatives" + icon: fa-graduation-cap + url: "/docs/imported/community/mentoring/" +intermediate: + - label: "Apply for community membership as a member, reviewer, approver, owner, or maintainer" + icon: fa-user-plus + url: "https://github.com/kubernetes/community/blob/master/community-membership.md" +advanced: + - label: "Learn about Kubernetes community governance" + icon: fa-gavel + url: "https://github.com/kubernetes/community/blob/master/governance.md" diff --git a/_data/user-personas/contributors/docs-contributor.yaml b/_data/user-personas/contributors/docs-contributor.yaml new file mode 100644 index 0000000000000..a48ce4d76f44b --- /dev/null +++ b/_data/user-personas/contributors/docs-contributor.yaml @@ -0,0 +1,40 @@ +id: docs-contributor +name: Docs Contributor +short_desc: A person who writes documentation for the Kubernetes project (e.g. this site). +index: 2 +foundational: + - label: "Contribute to the Kubernetes documentation" + icon: fa-users + url: "/editdocs/" + - label: "Learn about documentation style" + icon: fa-book + url: "/docs/home/contribute/style-guide/" + - label: "Review documentation issues" + icon: fa-bug + url: "/docs/home/contribute/review-issues/" + - label: "Create a documentation pull request (PR)" + icon: fa-pencil-square-o + url: "/docs/home/contribute/create-pull-request/" + - label: "Stage documentation changes" + icon: fa-eye + url: "/docs/home/contribute/stage-documentation-changes/#staging-a-pull-request" +intermediate: + - label: "Write a new topic" + icon: fa-plus-circle + url: "/docs/home/contribute/write-new-topic/" + - label: "Stage documentation changes locally" + icon: fa-cloud-download + url: "/docs/home/contribute/stage-documentation-changes/#staging-locally-using-docker" + - label: "Apply page templates" + icon: fa-clone + url: "/docs/home/contribute/page-templates/" + - label: "Add callout formatting" + icon: fa-exclamation-circle + url: "/docs/home/contribute/style-guide/#callout-formatting" +advanced: + - label: "Add feature state tags" + icon: fa-tag + url: "/docs/home/contribute/includes/#feature-state" + - label: "Add tabs to display multiple flavors of content" + icon: fa-folder-o + url: "/docs/home/contribute/includes/#tabs" diff --git a/_data/user-personas/migrators/docker-compose-swarm.yaml b/_data/user-personas/migrators/docker-compose-swarm.yaml new file mode 100644 index 0000000000000..797f276bf6199 --- /dev/null +++ b/_data/user-personas/migrators/docker-compose-swarm.yaml @@ -0,0 +1,24 @@ +id: docker-compose-swarm +name: Migrating from Docker Compose and Swarm +index: 1 +foundational: + - label: "b1: foundational stuff" + url: "#" + - label: "b2: foundational stuff" + url: "#" + - label: "b3: foundational stuff" + url: "#" +intermediate: + - label: "b1: intermediate stuff" + url: "#" + - label: "b2: intermediate stuff" + url: "#" + - label: "b3: intermediate stuff" + url: "#" +advanced: + - label: "b1: advanced stuff" + url: "#" + - label: "b2: advanced stuff" + url: "#" + - label: "b3: advanced stuff" + url: "#" diff --git a/_data/user-personas/migrators/heroku.yaml b/_data/user-personas/migrators/heroku.yaml new file mode 100644 index 0000000000000..1b2dcd8e253a2 --- /dev/null +++ b/_data/user-personas/migrators/heroku.yaml @@ -0,0 +1,24 @@ +id: heroku +name: Migrating from Heroku (PaaS) +index: 2 +foundational: + - label: "c1: foundational stuff" + url: "#" + - label: "c2: foundational stuff" + url: "#" + - label: "c3: foundational stuff" + url: "#" +intermediate: + - label: "c1: intermediate stuff" + url: "#" + - label: "c2: intermediate stuff" + url: "#" + - label: "c3: intermediate stuff" + url: "#" +advanced: + - label: "c1: advanced stuff" + url: "#" + - label: "c2: advanced stuff" + url: "#" + - label: "c3: advanced stuff" + url: "#" diff --git a/_data/user-personas/migrators/mesos.yaml b/_data/user-personas/migrators/mesos.yaml new file mode 100644 index 0000000000000..ee10859a543c4 --- /dev/null +++ b/_data/user-personas/migrators/mesos.yaml @@ -0,0 +1,24 @@ +id: mesos +name: Migrating from Apache Mesos +index: 3 +foundational: + - label: "d1: foundational stuff" + url: "#" + - label: "d2: foundational stuff" + url: "#" + - label: "d3: foundational stuff" + url: "#" +intermediate: + - label: "d1: intermediate stuff" + url: "#" + - label: "d2: intermediate stuff" + url: "#" + - label: "d3: intermediate stuff" + url: "#" +advanced: + - label: "d1: advanced stuff" + url: "#" + - label: "d2: advanced stuff" + url: "#" + - label: "d3: advanced stuff" + url: "#" diff --git a/_data/user-personas/migrators/vmware-openstack.yaml b/_data/user-personas/migrators/vmware-openstack.yaml new file mode 100644 index 0000000000000..45a889cd5229e --- /dev/null +++ b/_data/user-personas/migrators/vmware-openstack.yaml @@ -0,0 +1,24 @@ +id: vmware-openstack +name: Migrating from VMware and/or OpenStack +index: 0 +foundational: + - label: "a1: foundational stuff" + url: "#" + - label: "a2: foundational stuff" + url: "#" + - label: "a3: foundational stuff" + url: "#" +intermediate: + - label: "a1: intermediate stuff" + url: "#" + - label: "a2: intermediate stuff" + url: "#" + - label: "a3: intermediate stuff" + url: "#" +advanced: + - label: "a1: advanced stuff" + url: "#" + - label: "a2: advanced stuff" + url: "#" + - label: "a3: advanced stuff" + url: "#" diff --git a/_data/user-personas/users/app-developer.yaml b/_data/user-personas/users/app-developer.yaml new file mode 100644 index 0000000000000..21a1d1afbabfb --- /dev/null +++ b/_data/user-personas/users/app-developer.yaml @@ -0,0 +1,40 @@ +id: app-developer +name: Application Developer +glossary_id: application-developer +index: 0 +foundational: + - label: Get started with a cluster + icon: fa-television + url: /docs/user-journeys/users/application-developer/foundational + - label: Deploy an application + icon: fa-retweet + url: /docs/user-journeys/users/application-developer/foundational#section-2 + - label: Understand basic Kubernetes architecture + icon: fa-cog + url: /docs/user-journeys/users/application-developer/foundational#section-3 + - label: Explore additional resources + icon: fa-book + url: /docs/user-journeys/users/application-developer/foundational#section-4 +intermediate: + - label: Learn additional workload patterns + icon: fa-cogs + url: /docs/user-journeys/users/application-developer/intermediate + - label: Deploy a production-ready workload + icon: fa-retweet + url: /docs/user-journeys/users/application-developer/intermediate#section-2 + - label: Improve your dev workflow with tooling + icon: fa-scissors + url: /docs/user-journeys/users/application-developer/intermediate#section-3 + - label: Explore additional resources + icon: fa-book + url: /docs/user-journeys/users/application-developer/intermediate#section-4 +advanced: + - label: Deploy an application with advanced features + icon: fa-sliders + url: /docs/user-journeys/users/application-developer/advanced + - label: Extend the Kubernetes API + icon: fa-arrows + url: /docs/user-journeys/users/application-developer/advanced#section-2 + - label: Explore additional resources + icon: fa-book + url: /docs/user-journeys/users/application-developer/advanced#section-3 diff --git a/_data/user-personas/users/cluster-operator.yaml b/_data/user-personas/users/cluster-operator.yaml new file mode 100644 index 0000000000000..e17fc3865e89b --- /dev/null +++ b/_data/user-personas/users/cluster-operator.yaml @@ -0,0 +1,43 @@ +id: cluster-operator +name: Cluster Operator +glossary_id: cluster-operator +index: 1 +foundational: + - label: Get an overview of Kubernetes + icon: fa-globe + url: /docs/user-journeys/users/cluster-operator/foundational + - label: Learn about Kubernetes basics + icon: fa-cog + url: /docs/user-journeys/users/cluster-operator/foundational#section-2 + - label: Get information about my cluster + icon: fa-info-circle + url: /docs/user-journeys/users/cluster-operator/foundational#section-3 + - label: Explore additional resources + icon: fa-compass + url: /docs/user-journeys/users/cluster-operator/foundational#section-4 +intermediate: + - label: "Work with Ingress, Networking, Storage, Workloads" + icon: fa-sliders + url: /docs/user-journeys/users/cluster-operator/intermediate + - label: "Implement security best practices" + icon: fa-shield + url: /docs/user-journeys/users/cluster-operator/intermediate#section-2 + - label: "Implement custom logging and monitoring" + icon: fa-heartbeat + url: /docs/user-journeys/users/cluster-operator/intermediate#section-3 + - label: "Additional Resources" + icon: fa-book + url: /docs/user-journeys/users/cluster-operator/intermediate#section-4 +advanced: + - label: "Connect to managed services using Service Catalog" + icon: fa-puzzle-piece + url: "/docs/concepts/service-catalog/" + - label: "Extend a Kubernetes cluster" + icon: fa-arrows + url: "/docs/concepts/overview/extending/" + - label: "Create a Pod Security Policy" + icon: fa-lock + url: "/docs/concepts/policy/pod-security-policy/" + - label: "Define a Resource Quota" + icon: fa-tachometer + url: "/docs/concepts/policy/resource-quotas/" diff --git a/_includes/footer-scripts.html b/_includes/footer-scripts.html index 091545d12a73d..07f1e86bd8787 100644 --- a/_includes/footer-scripts.html +++ b/_includes/footer-scripts.html @@ -32,6 +32,7 @@ function hideNav(toc){ if (!toc) toc = document.querySelector('#docsToc') + if (!toc) return var container = toc.querySelector('.container') // container is built dynamically, so it may not be present on the first runloop diff --git a/_includes/head.html b/_includes/head.html index e6247c4cbb5cc..1c107cd2c1523 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -5,13 +5,14 @@ {% if page.case_study_styles %}{% else %}{% endif %} - - + + {% if page.deprecated %}{% endif %} {% if page.class == "gridPage" %}{% endif %} - {% if page.css %}{% else %}{% endif %} + {% if page.css %}{% assign csslist = page.css | split: ',' | compact %}{% for cssurl in csslist %} + {% endfor %}{% else %}{% endif %} {% if page.description %} @@ -19,11 +20,13 @@ {% endif %} - - + + + + - - + {% if page.js %}{% assign jslist = page.js | split: ',' | compact %}{% for jsurl in jslist %} + {% endfor %}{% else %}{% endif %} {% seo %} diff --git a/_includes/header.html b/_includes/header.html index 8db73df89d479..16b22650ba15d 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -23,7 +23,6 @@ {% endif %} {% endfor %} - diff --git a/_includes/partner-script.js b/_includes/partner-script.js index d319ab48d8774..f09191629e4ae 100644 --- a/_includes/partner-script.js +++ b/_includes/partner-script.js @@ -208,7 +208,7 @@ name: 'Spotinst', logo: 'spotinst', link: 'http://blog.spotinst.com/2016/08/04/elastigroup-kubernetes-minions-steroids/', - blurb: 'Spotinst uses a prediction algorithm in the Amazon EC2 Spot allowing k8s clusters to increase performance and lower the infrastructure costs' + blurb: 'Your Kubernetes For 80% Less. Run K8s workloads on Spot Instances with 100% availability to save 80% + autoscale your Kubernetes with maximum efficiency in heterogenous environments.' }, { type: 2, @@ -217,12 +217,12 @@ link: 'http://www.inwinstack.com/index.php/en/solutions-en/', blurb: 'Our container service leverages OpenStack-based infrastructure and its container orchestration engine Magnum to manage Kubernetes clusters.' }, - { - type: 3, - name: 'InwinSTACK', - logo: 'inwinstack', - link: 'https://github.com/inwinstack/kube-ansible', - blurb: 'inwinSTACK - kube-ansible' + { + type: 3, + name: 'InwinSTACK', + logo: 'inwinstack', + link: 'https://github.com/inwinstack/kube-ansible', + blurb: 'inwinSTACK - kube-ansible' }, { type: 1, @@ -281,11 +281,11 @@ blurb: 'CloudPlex enables operations teams to visually deploy, orchestrate, manage, and monitor infrastructure, applications, and services in public or private cloud.' }, { - type: 1, + type: 2, name: 'Kumina', logo: 'kumina', link: 'https://www.kumina.nl/managed_kubernetes', - blurb: 'Kumina creates Kubernetes solutions on your choice of infrastructure with around-the-clock management and unlimited support.' + blurb: 'Kumina combines the power of Kubernetes with 10+ years of experience in IT operations. We create, build and support fully managed Kubernetes solutions on your choice of infrastructure. We also provide consulting and training.' }, { type: 0, @@ -360,7 +360,7 @@ { type: 0, name: 'Mashape, Inc.', - logo: 'mashape', + logo: 'kong', link: 'https://getkong.org/install/kubernetes/', blurb: 'Kong is a scalable open source API layer that runs in front of any RESTful API and can be provisioned to a Kubernetes cluster.' }, @@ -490,6 +490,13 @@ link: 'https://tenxcloud.com', blurb: 'TenxCloud - TenxCloud Container Engine (TCE)' }, + { + type: 2, + name: 'TenxCloud', + logo: 'tenxcloud', + link: 'https://www.tenxcloud.com/', + blurb: 'Founded in October 2014, TenxCloud is a leading enterprise container cloud computing service provider in China, covering the areas such as container PaaS cloud platform, micro-service management, DevOps, development test, AIOps and so on. Provide private cloud PaaS products and solutions for financial, energy, operator, manufacturing, education and other industry customers.' + }, { type: 0, name: 'Twistlock', @@ -582,7 +589,7 @@ blurb: 'Container security solution for small-to-medium size enterprises who plan to run Kubernetes on shared infrastructure.' }, { - type: 1, + type: 2, name: 'Creationline, Inc.', logo: 'creationline', link: 'https://www.creationline.com/ci', @@ -705,7 +712,7 @@ name: 'Codefresh', logo: 'codefresh', link: 'https://codefresh.io/kubernetes-deploy/', - blurb: 'Codefresh is a complete tool chain for delivering containers to Kubernetes.' + blurb: 'Codefresh is a complete DevOps platform built for containers and Kubernetes. With CI/CD pipelines, image management, and deep integrations into Kubernetes and Helm.' }, { type: 0, @@ -728,6 +735,13 @@ link: 'https://cloud.google.com/kubernetes-engine/', blurb: 'Google - Google Kubernetes Engine' }, + { + type: 1, + name: 'Superorbital', + logo: 'superorbital', + link: 'https://superorbit.al/workshops/kubernetes/', + blurb: 'Helping companies navigate the Cloud Native waters through Kubernetes consulting and training.' + }, { type: 3, name: 'Apprenda', @@ -937,7 +951,7 @@ logo: 'microsoft', link: 'https://docs.microsoft.com/en-us/azure/aks/', blurb: 'Microsoft - Azure Container Service AKS' - }, + }, { type: 3, name: 'Oracle', @@ -1071,6 +1085,13 @@ link: 'http://www.alauda.cn/product/detail/id/68.html', blurb: 'Alauda - Alauda EE' }, + { + type: 2, + name: 'Alauda', + logo: 'alauda', + link: 'www.alauda.io', + blurb: 'Alauda provides Kubernetes-Centric Enterprise Platform-as-a-Service offerings with a razor focus on delivering Cloud Native capabilities and DevOps best practices to enterprise customers across industries in China.' + }, { type: 3, name: 'EasyStack', @@ -1125,7 +1146,7 @@ name: 'Pure Storage', logo: 'pure_storage', link: 'https://hub.docker.com/r/purestorage/k8s/', - blurb: 'Our flexvol driver and dynamic provisioner allow FlashArray/Flashblade storage devices to be consumed as first class persistent storage from within Kuberentes.' + blurb: 'Our flexvol driver and dynamic provisioner allow FlashArray/Flashblade storage devices to be consumed as first class persistent storage from within Kubernetes.' }, { type: 0, @@ -1138,7 +1159,7 @@ type: 0, name: 'Portworx', logo: 'portworx', - link: 'https://docs.portworx.com/scheduler/kubernetes/install.html', + link: 'https://portworx.com/use-case/kubernetes-storage/', blurb: 'With Portworx, you can manage any database or stateful service on any infrastructure using Kubernetes. You get a single data management layer for all of your stateful services, no matter where they run.' }, { @@ -1183,6 +1204,258 @@ link: 'https://cloudbourne.com/kubernetes-enterprise-hybrid-cloud/', blurb: 'Want to achieve maximum build, deploy and monitoring automation using Kubernetes? We can help.' }, + { + type: 0, + name: 'CloudBourne', + logo: 'cloudbourne', + link: 'https://cloudbourne.com/', + blurb: 'Our AppZ Hybrid Cloud Platform can help you achieve your digital transformation goals using the powerful Kubernetes.' + }, + { + type: 3, + name: 'BoCloud', + logo: 'bocloud', + link: 'http://www.bocloud.com.cn/en/index.html', + blurb: 'BoCloud - BeyondcentContainer' + }, + { + type: 2, + name: 'Naitways', + logo: 'naitways', + link: 'https://www.naitways.com/', + blurb: 'Naitways is an Operator (AS57119), Integrator and Cloud Services Provider (our own !). We aim to provide value-added services through our mastering of the whole value chain (Infrastructure, Network, Human skills). Private and Public Cloud is available through Kubernetes managed or unmanaged.' + }, + { + type: 2, + name: 'Kinvolk', + logo: 'kinvolk', + link: 'https://kinvolk.io/kubernetes/', + blurb: 'Kinvolk offers Kubernetes engineering & operations support from cluster to kernel. Leading cloud-native organizations turn to Kinvolk for deep-stack Linux expertise.' + }, + { + type: 1, + name: 'Cascadeo Corporation', + logo: 'cascadeo', + link: 'http://www.cascadeo.com/', + blurb: 'Cascadeo designs, implements, and manages containerized workloads with Kubernetes, for both existing applications and greenfield development projects.' + }, + { + type: 1, + name: 'Elastisys AB', + logo: 'elastisys', + link: 'https://elastisys.com/services/#kubernetes', + blurb: 'We design, build, and operate Kubernetes clusters. We are experts in highly available and self-optimizing Kubernetes infrastructures' + }, + { + type: 1, + name: 'Greenfield Guild', + logo: 'greenfield', + link: 'http://greenfieldguild.com/', + blurb: 'The Greenfield Guild builds quality open source solutions on, and offers training and support for, Kubernetes in any environment.' + }, + { + type: 1, + name: 'PolarSeven', + logo: 'polarseven', + link: 'https://polarseven.com/what-we-do/kubernetes/', + blurb: 'To get started up and running with Kubernetes (K8s) our PolarSeven consultants can help you with creating a fully functional dockerized environment to run and deploy your applications.' + }, + { + type: 1, + name: 'Kloia', + logo: 'kloia', + link: 'https://kloia.com/kubernetes/', + blurb: 'Kloia is DevOps and Microservices Consultancy company that helps its customers to migrate their environment to cloud platforms for enabling more scalable and secure environments. We use Kubernetes to provide our customers all-in-one solutions in an cloud-agnostic way.' + }, + { + type: 0, + name: 'Bluefyre', + logo: 'bluefyre', + link: 'https://www.bluefyre.io', + blurb: 'Bluefyre offers a developer-first security platform that is native to Kubernetes. Bluefyre helps your development team ship secure code on Kubernetes faster!' + }, + { + type: 0, + name: 'Harness', + logo: 'harness', + link: 'https://harness.io/harness-continuous-delivery/secret-sauce/smart-automation/', + blurb: 'Harness offers Continuous Delivery As-A-Service will full support for containerized apps and Kubernetes clusters.' + }, + { + type: 0, + name: 'VMware - Wavefront', + logo: 'wavefront', + link: 'https://www.wavefront.com/solutions/container-monitoring/', + blurb: 'The Wavefront platform provides metrics-driven analytics and monitoring for Kubernetes and container dashboards for DevOps and developer teams delivering visibility into high-level services as well as granular container metrics.' + }, + { + type: 0, + name: 'Bloombase, Inc.', + logo: 'bloombase', + link: 'https://www.bloombase.com/go/kubernetes', + blurb: 'Bloombase provides high bandwidth, defense-in-depth data-at-rest encryption to lock down Kubernetes crown-jewels at scale.' + }, + { + type: 0, + name: 'Kasten', + logo: 'kasten', + link: 'https://kasten.io/product/', + blurb: 'Kasten provides enterprise solutions specifically built to address the operational complexity of data management in cloud-native environments.' + }, + { + type: 0, + name: 'Humio', + logo: 'humio', + link: 'https://humio.com', + blurb: 'Humio is a log aggregation database. We offer a Kubernetes integration that will give you insights to your logs across apps and instances.' + }, + { + type: 0, + name: 'Outcold Solutions LLC', + logo: 'outcold', + link: 'https://www.outcoldsolutions.com/#monitoring-kubernetes', + blurb: 'Powerful Certified Splunk applications for Monitoring OpenShift, Kubernetes and Docker.' + }, + { + type: 0, + name: 'SysEleven GmbH', + logo: 'syseleven', + link: 'http://www.syseleven.de/', + blurb: 'Enterprise Customers who are in need of bulletproof operations (High Performance E-Commerce and Enterprise Portals)' + }, + { + type: 0, + name: 'Landoop', + logo: 'landoop', + link: 'http://lenses.stream', + blurb: 'Lenses for Apache Kafka, to deploy, manage and operate with confidence data streaming pipelines and topologies at scale with confidence and native Kubernetes integration.' + }, + { + type: 0, + name: 'Redis Labs', + logo: 'redis', + link: 'https://redislabs.com/blog/getting-started-with-kubernetes-and-redis-using-redis-enterprise/', + blurb: 'Redis Enterprise extends open source Redis and delivers stable high performance and linear scaling required for building microservices on the Kubernetes platform.' + }, + { + type: 3, + name: 'Diamanti', + logo: 'diamanti', + link: 'https://diamanti.com/', + blurb: 'Diamanti - Diamanti-D10' + }, + { + type: 3, + name: 'Eking', + logo: 'eking', + link: 'http://www.eking-tech.com/', + blurb: 'Hainan eKing Technology Co. - eKing Cloud Container Platform' + }, + { + type: 3, + name: 'Harmony Cloud', + logo: 'harmony', + link: 'http://harmonycloud.cn/products/rongqiyun/', + blurb: 'Harmonycloud - Harmonycloud Container Platform' + }, + { + type: 3, + name: 'Woqutech', + logo: 'woqutech', + link: 'http://www.woqutech.com/product/product-16-247.html#sss', + blurb: 'Woqutech - QFusion' + }, + { + type: 3, + name: 'Baidu', + logo: 'baidu', + link: 'https://cloud.baidu.com/product/cce.html', + blurb: 'Baidu Cloud - Baidu Cloud Container Engine' + }, + { + type: 3, + name: 'ZTE', + logo: 'zte', + link: 'https://sdnfv.zte.com.cn/en/home', + blurb: 'ZTE - TECS OpenPalette' + }, + { + type: 1, + name: 'Automatic Server AG', + logo: 'asag', + link: 'http://www.automatic-server.com/paas.html', + blurb: 'We install and operate Kubernetes in big enterprises, create deployment workflows and help to migrate.' + }, + { + type: 1, + name: 'Circulo Siete', + logo: 'circulo', + link: 'https://circulosiete.com/consultoria/kubernetes/', + blurb: 'We are a Mexico based company offering training, consulting and support to migrate your workloads to Kubernetes, Cloud Native Microservices & Devops.' + }, + { + type: 1, + name: 'DevOpsGuru', + logo: 'devopsguru', + link: 'http://devopsguru.ca/workshop', + blurb: 'DevOpsGuru work with small business to transform from physical to virtual to containerization.' + }, + { + type: 1, + name: 'EIN Intelligence Co., Ltd', + logo: 'ein', + link: 'https://ein.io', + blurb: 'Startups and agile enterprises in South Korea.' + }, + { + type: 0, + name: 'GuardiCore', + logo: 'guardicore', + link: 'https://www.guardicore.com/', + blurb: 'GuardiCore provided process level visibility and network policy enforcement on containerized assets on the Kubernetes platform.' + }, + { + type: 0, + name: 'Hedvig', + logo: 'hedvig', + link: 'https://www.hedviginc.com/blog/provisioning-hedvig-storage-with-kubernetes', + blurb: 'Hedvig is software-defined storage that uses NFS or iSCSI for persistent volumes for provisioning shared storage for pods and containers.' + }, + { + type: 0, + name: 'Hewlett Packard Enterprise', + logo: 'hpe', + link: ' https://www.hpe.com/us/en/storage/containers.html', + blurb: 'Persistent Storage that makes data as easy to manage as containers: dynamic provisioning, policy-based performance & protection, QoS, & more.' + }, + { + type: 0, + name: 'JetBrains', + logo: 'jetbrains', + link: 'https://blog.jetbrains.com/teamcity/2017/10/teamcity-kubernetes-support-plugin/', + blurb: 'Run TeamCity cloud build agents in a Kubernetes cluster. Provides Helm support as a build step.' + }, + { + type: 2, + name: 'Opensense', + logo: 'opensense', + link: 'http://www.opensense.fr/en/kubernetes-en/', + blurb: 'We provide Kubernetes services (integration, operation, training) as well as development of banking microservices based on our extended experience with cloud of containers, microservices, data management and financial sector.' + }, + { + type: 2, + name: 'SAP SE', + logo: 'sap', + link: 'https://cloudplatform.sap.com', + blurb: 'The SAP Cloud Platform provides in-memory capabilities and unique business services for building and extending applications. With open sourced Project Gardener, SAP utilizes the power of Kubernetes to enable an open, robust, multi-cloud experience for our customers. You can use simple, modern cloud native design principles and leverage skills your organization already has to deliver agile and transformative applications, while integrating with the latest SAP Leonardo business features.' + }, + { + type: 1, + name: 'Mobilise Cloud Services Limited', + logo: 'mobilise', + link: 'http://www.mobilise.cloud/services/serverless-application-delivery', + blurb: 'Mobilise helps organisations adopt Kubernetes and integrate with their CI/CD tooling.' + }, { type: 0, name: 'Logdna', diff --git a/_includes/templates/user-journey-content.md b/_includes/templates/user-journey-content.md new file mode 100644 index 0000000000000..5c9e731bcbe16 --- /dev/null +++ b/_includes/templates/user-journey-content.md @@ -0,0 +1,26 @@ +
{{ page.track }}
+
+ Introduction +
+
sections in this doc
+
+ +
+ +
+ +{% if overview %} +{{ overview | liquify | markdownify }} +{% else %} +{% include templates/_errorthrower.md missing_block='overview' purpose='provides an introduction of this level.' %} +{% endif %} + +{% if body %} +{{ body | liquify | markdownify | replace: '', '
'}} +{% else %} +{% include templates/_errorthrower.md missing_block='body' purpose='contains content for this level.' %} +{% endif %} + +
+ + diff --git a/_includes/tocsearch.html b/_includes/tocsearch.html index 5bd5c5fd50695..708c8357f07c3 100644 --- a/_includes/tocsearch.html +++ b/_includes/tocsearch.html @@ -6,7 +6,12 @@ {% if item.section %} {% include tocsearch.html tree=item.section toc=include.toc %} {% else %} - {% if item == page.path %} + {% if item.path %} + {% assign filename = item.path | replace: '/', ' ' | strip | replace: ' ', '/' | append: '.md' %} + {% else %} + {% assign filename = item %} + {% endif %} + {% if filename == page.path %} {% assign found_toc = include.toc %} {% break %} {% endif %} diff --git a/_includes/v1.3/extensions-v1beta1-definitions.html b/_includes/v1.3/extensions-v1beta1-definitions.html deleted file mode 100755 index 0b9a667757ef6..0000000000000 --- a/_includes/v1.3/extensions-v1beta1-definitions.html +++ /dev/null @@ -1,6018 +0,0 @@ - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1beta1.DeploymentStatus

-
-

DeploymentStatus is the most recently observed status of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

The generation observed by the deployment controller.

false

integer (int64)

replicas

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

false

integer (int32)

updatedReplicas

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

false

integer (int32)

availableReplicas

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

false

integer (int32)

unavailableReplicas

Total number of unavailable pods targeted by this deployment.

false

integer (int32)

- -
-
-

v1beta1.DaemonSetStatus

-
-

DaemonSetStatus represents the current status of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

currentNumberScheduled

CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/release-1.3/docs/admin/daemons.md

true

integer (int32)

numberMisscheduled

NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/release-1.3/docs/admin/daemons.md

true

integer (int32)

desiredNumberScheduled

DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/release-1.3/docs/admin/daemons.md

true

integer (int32)

- -
-
-

v1beta1.Job

-
-

Job represents the configuration of a single job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobSpec

status

Status is a structure describing current status of a job. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobStatus

- -
-
-

v1.Preconditions

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

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

false

string

fieldPath

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

true

string

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

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

false

string

role

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

false

string

type

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

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

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

false

boolean

false

mountPath

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

true

string

subPath

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

false

string

- -
-
-

v1beta1.IngressSpec

-
-

IngressSpec describes the Ingress the user wishes to exist.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

backend

A default backend capable of servicing requests that don’t match any rule. At least one of backend or rules must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.

false

v1beta1.IngressBackend

tls

TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

false

v1beta1.IngressTLS array

rules

A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

false

v1beta1.IngressRule array

- -
-
-

v1beta1.IngressBackend

-
-

IngressBackend describes all endpoints for a given service and port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

serviceName

Specifies the name of the referenced service.

true

string

servicePort

Specifies the port of the referenced service.

true

string

- -
-
-

v1beta1.ReplicaSetList

-
-

ReplicaSetList is a collection of ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of ReplicaSets. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md

true

v1beta1.ReplicaSet array

- -
-
-

v1.CephFSVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

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

true

string array

path

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

false

string

user

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

false

string

secretFile

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

- -
-
-

v1beta1.IngressStatus

-
-

IngressStatus describe the current state of the Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

loadBalancer

LoadBalancer contains the current status of the load-balancer.

false

v1.LoadBalancerStatus

- -
-
-

v1.DownwardAPIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

- -
-
-

unversioned.StatusCause

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

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

false

string

message

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

false

string

field

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

false

string

- -
-
-

v1beta1.NetworkPolicyList

-
-

Network Policy List is a list of NetworkPolicy objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of schema objects.

true

v1beta1.NetworkPolicy array

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

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

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

readOnly

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

false

boolean

false

- -
-
-

v1beta1.RollingUpdateDeployment

-
-

Spec to control the desired behavior of rolling update.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

maxUnavailable

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

false

string

maxSurge

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.

false

string

- -
-
-

v1beta1.HTTPIngressRuleValue

-
-

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

paths

A collection of paths that map requests to backends.

true

v1beta1.HTTPIngressPath array

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

*versioned.Event

- -
-
-

v1beta1.JobStatus

-
-

JobStatus represents the current state of a Job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

conditions

Conditions represent the latest available observations of an object’s current state. More info: http://releases.k8s.io/release-1.3/docs/user-guide/jobs.md

false

v1beta1.JobCondition array

startTime

StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string

completionTime

CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string

active

Active is the number of actively running pods.

false

integer (int32)

succeeded

Succeeded is the number of pods which reached Phase Succeeded.

false

integer (int32)

failed

Failed is the number of pods which reached Phase Failed.

false

integer (int32)

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.LocalObjectReference

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.ObjectMeta

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

false

string

selfLink

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

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

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

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

string

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

string

deletionGracePeriodSeconds

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

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.3/docs/user-guide/annotations.md

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

- -
-
-

v1beta1.ReplicaSetSpec

-
-

ReplicaSetSpec is the specification of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

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

false

integer (int32)

selector

Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

v1beta1.LabelSelector

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md#pod-template

false

v1.PodTemplateSpec

- -
-
-

v1beta1.DaemonSetSpec

-
-

DaemonSetSpec is the specification of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selector

Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

v1beta1.LabelSelector

template

Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md#pod-template

true

v1.PodTemplateSpec

- -
-
-

v1beta1.Deployment

-
-

Deployment enables declarative updates for Pods and ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata.

false

v1.ObjectMeta

spec

Specification of the desired behavior of the Deployment.

false

v1beta1.DeploymentSpec

status

Most recently observed status of the Deployment.

false

v1beta1.DeploymentStatus

- -
-
-

v1.AzureFileVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

true

string

shareName

Share Name

true

string

readOnly

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

false

boolean

false

- -
-
-

types.UID

- -
-
-

v1.ISCSIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

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

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

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

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#iscsi

false

string

readOnly

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

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#emptydir

false

string

- -
-
-

v1beta1.IngressList

-
-

IngressList is a collection of Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of Ingress.

true

v1beta1.Ingress array

- -
-
-

v1beta1.ScaleSpec

-
-

describes the attributes of a scale subresource

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

- -
-
-

unversioned.Patch

-
-

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

-
-
-
-

v1.FlockerVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

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

true

string

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

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

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

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

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1beta1.HorizontalPodAutoscaler

-
-

configuration of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

behaviour of autoscaler. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status.

false

v1beta1.HorizontalPodAutoscalerSpec

status

current information about the autoscaler.

false

v1beta1.HorizontalPodAutoscalerStatus

- -
-
-

v1beta1.RollbackConfig

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

revision

The revision to rollback to. If set to 0, rollbck to the last revision.

false

integer (int64)

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

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

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

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

false

v1.SecretKeySelector

- -
-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

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

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1beta1.JobCondition

-
-

JobCondition describes current state of a job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of job condition, Complete or Failed.

true

string

status

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

true

string

lastProbeTime

Last time the condition was checked.

false

string

lastTransitionTime

Last time the condition transit from one status to another.

false

string

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.LoadBalancerIngress

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

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

false

string

hostname

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

false

string

- -
-
-

v1beta1.APIVersion

-
-

An APIVersion represents a single concrete version of an object model.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of this version (e.g. v1).

false

string

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

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

false

v1.Preconditions

orphanDependents

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

false

boolean

false

- -
-
-

v1.Volume

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

emptyDir

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

false

v1.EmptyDirVolumeSource

gcePersistentDisk

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

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

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

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

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

false

v1.SecretVolumeSource

nfs

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

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/examples/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

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

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

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

false

v1.PersistentVolumeClaimVolumeSource

rbd

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

false

v1.RBDVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

cinder

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

false

v1.CinderVolumeSource

cephfs

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

false

v1.CephFSVolumeSource

flocker

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

false

v1.FlockerVolumeSource

downwardAPI

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

false

v1.DownwardAPIVolumeSource

fc

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

false

v1.FCVolumeSource

azureFile

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

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

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

false

v1.VsphereVirtualDiskVolumeSource

- -
-
-

v1beta1.DaemonSetList

-
-

DaemonSetList is a collection of daemon sets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of daemon sets.

true

v1beta1.DaemonSet array

- -
-
-

v1.ResourceFieldSelector

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

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

false

string

- -
-
-

v1.Probe

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

initialDelaySeconds

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

false

integer (int32)

timeoutSeconds

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

false

integer (int32)

periodSeconds

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

false

integer (int32)

successThreshold

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

false

integer (int32)

failureThreshold

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

false

integer (int32)

- -
-
-

v1beta1.DeploymentSpec

-
-

DeploymentSpec is the specification of the desired behavior of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

false

integer (int32)

selector

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

false

v1beta1.LabelSelector

template

Template describes the pods that will be created.

true

v1.PodTemplateSpec

strategy

The deployment strategy to use to replace existing pods with new ones.

false

v1beta1.DeploymentStrategy

minReadySeconds

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

false

integer (int32)

revisionHistoryLimit

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.

false

integer (int32)

paused

Indicates that the deployment is paused and will not be processed by the deployment controller.

false

boolean

false

rollbackTo

The config this deployment is rolling back to. Will be cleared after rollback is done.

false

v1beta1.RollbackConfig

- -
-
-

unversioned.APIResourceList

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

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

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

key

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

true

string

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

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

true

string

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

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

true

string

fieldRef

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

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

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

true

integer (int32)

protocol

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

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

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

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/containers.md

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#restartpolicy

false

string

terminationGracePeriodSeconds

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

false

integer (int64)

activeDeadlineSeconds

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

false

integer (int64)

dnsPolicy

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

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.3/docs/user-guide/node-selection/README.md

false

object

serviceAccountName

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

false

string

serviceAccount

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

false

string

nodeName

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

false

string

hostNetwork

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

false

boolean

false

hostPID

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

false

boolean

false

hostIPC

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

false

boolean

false

securityContext

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

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

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

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.3/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.3/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

- -
-
-

v1.GlusterfsVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

- -
-
-

v1beta1.IngressTLS

-
-

IngressTLS describes the transport layer security associated with an Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hosts

Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.

false

string array

secretName

SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

false

string

- -
-
-

v1beta1.SubresourceReference

-
-

SubresourceReference contains enough information to let you inspect or modify the referred subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent; More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

name

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

false

string

apiVersion

API version of the referent

false

string

subresource

Subresource name of the referent

false

string

- -
-
-

v1beta1.Scale

-
-

represents a scaling request for a resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.ScaleSpec

status

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

false

v1beta1.ScaleStatus

- -
-
-

v1.RBDVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

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

true

string array

image

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

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#rbd

false

string

pool

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

false

string

user

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

false

string

keyring

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

- -
-
-

v1beta1.NetworkPolicy

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

Specification of the desired behavior for this NetworkPolicy.

false

v1beta1.NetworkPolicySpec

- -
-
-

v1beta1.ScaleStatus

-
-

represents the current status of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

label query over pods that should match the replicas count. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

object

targetSelector

label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

string

- -
-
-

v1beta1.NetworkPolicySpec

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.

true

v1beta1.LabelSelector

ingress

List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list.

false

v1beta1.NetworkPolicyIngressRule array

- -
-
-

v1.NFSVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

- -
-
-

v1beta1.DeploymentList

-
-

DeploymentList is a list of Deployments.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of Deployments.

true

v1beta1.Deployment array

- -
-
-

v1beta1.DeploymentRollback

-
-

DeploymentRollback stores the information required to rollback a deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

name

Required: This must match the Name of a deployment.

true

string

updatedAnnotations

The annotations to be updated to a deployment

false

object

rollbackTo

The config of this deployment rollback.

true

v1beta1.RollbackConfig

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1beta1.HorizontalPodAutoscalerStatus

-
-

current status of a horizontal pod autoscaler

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

most recent generation observed by this autoscaler.

false

integer (int64)

lastScaleTime

last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.

false

string

currentReplicas

current number of replicas of pods managed by this autoscaler.

true

integer (int32)

desiredReplicas

desired number of replicas of pods managed by this autoscaler.

true

integer (int32)

currentCPUUtilizationPercentage

current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.

false

integer (int32)

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target world wide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

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

false

boolean

false

- -
-
-

v1beta1.ThirdPartyResource

-
-

A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata

false

v1.ObjectMeta

description

Description is the description of this object.

false

string

versions

Versions are versions for this third party object

false

v1beta1.APIVersion array

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

v1beta1.DeploymentStrategy

-
-

DeploymentStrategy describes how to replace existing pods with new ones.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

false

string

rollingUpdate

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

false

v1beta1.RollingUpdateDeployment

- -
-
-

v1beta1.IngressRule

-
-

IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

host

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
- 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.

false

string

http

false

v1beta1.HTTPIngressRuleValue

- -
-
-

v1beta1.JobList

-
-

JobList is a collection of jobs.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of Job.

true

v1beta1.Job array

- -
-
-

v1beta1.NetworkPolicyPeer

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.

false

v1beta1.LabelSelector

namespaceSelector

Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.

false

v1beta1.LabelSelector

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

group

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

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

causes

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

false

unversioned.StatusCause array

retryAfterSeconds

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

false

integer (int32)

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

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

false

string

scheme

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

false

string

httpHeaders

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

false

v1.HTTPHeader array

- -
-
-

v1beta1.CPUTargetUtilization

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPercentage

fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use.

true

integer (int32)

- -
-
-

v1.LoadBalancerStatus

-
-

LoadBalancerStatus represents the status of a load-balancer.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ingress

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

false

v1.LoadBalancerIngress array

- -
-
-

v1.Container

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

image

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

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/containers.md#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/containers.md#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

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

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

volumeMounts

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

false

v1.VolumeMount array

livenessProbe

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

false

v1.Probe

readinessProbe

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

false

v1.Probe

lifecycle

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

false

v1.Lifecycle

terminationMessagePath

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

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/release-1.3/docs/design/security_context.md

false

v1.SecurityContext

stdin

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

false

boolean

false

stdinOnce

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

false

boolean

false

tty

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

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

supplementalGroups

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

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1beta1.NetworkPolicyIngressRule

-
-

This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ports

List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.

false

v1beta1.NetworkPolicyPort array

from

List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.

false

v1beta1.NetworkPolicyPeer array

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

true

string

name

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

true

string

uid

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

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

v1beta1.ReplicaSetStatus

-
-

ReplicaSetStatus represents the current status of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

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

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

false

integer (int64)

- -
-
-

v1beta1.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

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

false

v1beta1.LabelSelectorRequirement array

- -
-
-

v1beta1.ReplicaSet

-
-

ReplicaSet represents the configuration of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

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

false

v1beta1.ReplicaSetSpec

status

Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.ReplicaSetStatus

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#hostpath

true

string

- -
-
-

v1beta1.DaemonSet

-
-

DaemonSet represents the configuration of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.DaemonSetSpec

status

Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.DaemonSetStatus

- -
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

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

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.Protocol

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

- -
-
-

v1beta1.HorizontalPodAutoscalerSpec

-
-

specification of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

scaleRef

reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec.

true

v1beta1.SubresourceReference

minReplicas

lower limit for the number of pods that can be set by the autoscaler, default 1.

false

integer (int32)

maxReplicas

upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

true

integer (int32)

cpuUtilization

target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources.

false

v1beta1.CPUTargetUtilization

- -
-
-

v1beta1.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

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

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://releases.k8s.io/release-1.3/docs/design/resources.md#resource-specifications

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/release-1.3/docs/design/resources.md#resource-specifications

false

object

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PodSpec

- -
-
-

v1beta1.NetworkPolicyPort

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

protocol

Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

false

v1.Protocol

port

If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.

false

string

- -
-
-

v1beta1.JobSpec

-
-

JobSpec describes how the job execution will look like.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

parallelism

Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://releases.k8s.io/release-1.3/docs/user-guide/jobs.md

false

integer (int32)

completions

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://releases.k8s.io/release-1.3/docs/user-guide/jobs.md

false

integer (int32)

activeDeadlineSeconds

Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

false

integer (int64)

selector

Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

v1beta1.LabelSelector

autoSelector

AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/release-1.3/docs/design/selector-generation.md

false

boolean

false

template

Template is the object that describes the pod that will be created when executing a job. More info: http://releases.k8s.io/release-1.3/docs/user-guide/jobs.md

true

v1.PodTemplateSpec

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

string

message

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

false

string

reason

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

false

string

details

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

false

unversioned.StatusDetails

code

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

false

integer (int32)

- -
-
-

v1beta1.HorizontalPodAutoscalerList

-
-

list of horizontal pod autoscaler objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

list of horizontal pod autoscaler objects.

true

v1beta1.HorizontalPodAutoscaler array

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

key

The key to select.

true

string

- -
-
-

v1beta1.HTTPIngressPath

-
-

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend.

false

string

backend

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

true

v1beta1.IngressBackend

- -
-
-

v1beta1.Ingress

-
-

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec is the desired state of the Ingress. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.IngressSpec

status

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

false

v1beta1.IngressStatus

- -
-
-

v1beta1.ThirdPartyResourceList

-
-

ThirdPartyResourceList is a list of ThirdPartyResources.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of ThirdPartyResources.

true

v1beta1.ThirdPartyResource array

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.3/extensions-v1beta1-operations.html b/_includes/v1.3/extensions-v1beta1-operations.html deleted file mode 100755 index bcdf55fa3beef..0000000000000 --- a/_includes/v1.3/extensions-v1beta1-operations.html +++ /dev/null @@ -1,15661 +0,0 @@ - - - - - - -Operations - - - -
-
-

Operations

-
-
-

get available resources

-
-
-
GET /apis/extensions/v1beta1
-
-
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

unversioned.APIResourceList

- -
-
-

Consumes

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscalerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.IngressList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Job

-
-
-
GET /apis/extensions/v1beta1/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.JobList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of DaemonSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a DaemonSet

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified DaemonSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a DaemonSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified DaemonSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified DaemonSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified DaemonSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Deployment

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a Deployment

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Deployment

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a Deployment

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Deployment

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create rollback of a DeploymentRollback

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DeploymentRollback

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DeploymentRollback

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentRollback

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Deployment

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Deployment

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscalerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of HorizontalPodAutoscaler

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a HorizontalPodAutoscaler

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified HorizontalPodAutoscaler

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a HorizontalPodAutoscaler

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified HorizontalPodAutoscaler

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified HorizontalPodAutoscaler

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified HorizontalPodAutoscaler

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.IngressList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Ingress

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create an Ingress

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Ingress

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete an Ingress

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Ingress

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Ingress

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Ingress

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.JobList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Job

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a Job

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Job

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a Job

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Job

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Job

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Job

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicyList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of NetworkPolicy

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a NetworkPolicy

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.NetworkPolicy

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified NetworkPolicy

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.NetworkPolicy

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a NetworkPolicy

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified NetworkPolicy

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of ReplicaSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a ReplicaSet

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified ReplicaSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a ReplicaSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified ReplicaSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified ReplicaSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified ReplicaSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicyList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResourceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of ThirdPartyResource

-
-
-
DELETE /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a ThirdPartyResource

-
-
-
POST /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ThirdPartyResource

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified ThirdPartyResource

-
-
-
PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ThirdPartyResource

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a ThirdPartyResource

-
-
-
DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified ThirdPartyResource

-
-
-
PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Job

-
-
-
GET /apis/extensions/v1beta1/watch/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Job

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Job

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/watch/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/watch/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.3/v1-definitions.html b/_includes/v1.3/v1-definitions.html deleted file mode 100755 index 42ed010f3c0c8..0000000000000 --- a/_includes/v1.3/v1-definitions.html +++ /dev/null @@ -1,7806 +0,0 @@ - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1.Node

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.NodeSpec

status

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

false

v1.NodeStatus

- -
-
-

v1.PersistentVolumeClaimList

-
-

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.PersistentVolumeClaim array

- -
-
-

v1.Preconditions

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

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

false

string

role

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

false

string

type

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

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

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

false

string

fieldPath

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

true

string

- -
-
-

v1.ContainerStateRunning

-
-

ContainerStateRunning is a running state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

startedAt

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

false

string

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

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

false

boolean

false

mountPath

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

true

string

subPath

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

false

string

- -
-
-

v1.PersistentVolumeClaimSpec

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

accessModes

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

false

v1.PersistentVolumeAccessMode array

selector

A label query over volumes to consider for binding.

false

unversioned.LabelSelector

resources

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

false

v1.ResourceRequirements

volumeName

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

false

string

- -
-
-

v1.CephFSVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

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

true

string array

path

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

false

string

user

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

false

string

secretFile

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

- -
-
-

v1.DownwardAPIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

- -
-
-

unversioned.StatusCause

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

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

false

string

message

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

false

string

field

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

false

string

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

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

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

readOnly

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

false

boolean

false

- -
-
-

v1.ResourceQuotaSpec

-
-

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hard

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

false

object

scopes

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

false

v1.ResourceQuotaScope array

- -
-
-

v1.NamespaceStatus

-
-

NamespaceStatus is information about the current status of a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

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

false

string

- -
-
-

v1.NamespaceSpec

-
-

NamespaceSpec describes the attributes on a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

finalizers

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

false

v1.FinalizerName array

- -
-
-

v1.PersistentVolume

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PersistentVolumeSpec

status

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

false

v1.PersistentVolumeStatus

- -
-
-

v1.ConfigMapList

-
-

ConfigMapList is a resource containing a list of ConfigMap objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of ConfigMaps.

true

v1.ConfigMap array

- -
-
-

v1.PersistentVolumeStatus

-
-

PersistentVolumeStatus is the current status of a persistent volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

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

false

string

message

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

false

string

reason

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

false

string

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

- -
-
-

*versioned.Event

- -
-
-

v1.EndpointsList

-
-

EndpointsList is a list of endpoints.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of endpoints.

true

v1.Endpoints array

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

v1.ScaleStatus

-
-

ScaleStatus represents the current status of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

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

false

string

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.ConfigMap

-
-

ConfigMap holds configuration data for pods to consume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

data

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

false

object

- -
-
-

v1.PodTemplateList

-
-

PodTemplateList is a list of PodTemplates.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of pod templates

true

v1.PodTemplate array

- -
-
-

v1.NodeCondition

-
-

NodeCondition contains condition infromation for a node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of node condition.

true

string

status

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

true

string

lastHeartbeatTime

Last time we got an update on a given condition.

false

string

lastTransitionTime

Last time the condition transit from one status to another.

false

string

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.LocalObjectReference

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

- -
-
-

v1.ResourceQuotaStatus

-
-

ResourceQuotaStatus defines the enforced hard limits and observed use.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hard

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

false

object

used

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

false

object

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.ObjectMeta

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

false

string

selfLink

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

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

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

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

string

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

string

deletionGracePeriodSeconds

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

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.3/docs/user-guide/annotations.md

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

- -
-
-

v1.LimitRangeSpec

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits is the list of LimitRangeItem objects that are enforced.

true

v1.LimitRangeItem array

- -
-
-

types.UID

- -
-
-

v1.AzureFileVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

true

string

shareName

Share Name

true

string

readOnly

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

false

boolean

false

- -
-
-

v1.ISCSIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

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

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

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

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#iscsi

false

string

readOnly

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

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#emptydir

false

string

- -
-
-

v1.NodeList

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of nodes

true

v1.Node array

- -
-
-

unversioned.Patch

-
-

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

-
-
-
-

v1.NamespaceList

-
-

NamespaceList is a list of Namespaces.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.Namespace array

- -
-
-

v1.PersistentVolumeClaim

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PersistentVolumeClaimSpec

status

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

false

v1.PersistentVolumeClaimStatus

- -
-
-

v1.ServiceAccount

-
-

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

secrets

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

false

v1.ObjectReference array

imagePullSecrets

ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://releases.k8s.io/release-1.3/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

false

v1.LocalObjectReference array

- -
-
-

v1.NodeAddress

-
-

NodeAddress contains information for the node’s address.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Node address type, one of Hostname, ExternalIP or InternalIP.

true

string

address

The node address.

true

string

- -
-
-

v1.Namespace

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.NamespaceSpec

status

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

false

v1.NamespaceStatus

- -
-
-

v1.FlockerVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

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

true

string

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

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

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

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

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1.ResourceQuotaList

-
-

ResourceQuotaList is a list of ResourceQuota items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.ResourceQuota array

- -
-
-

v1.PersistentVolumeClaimStatus

-
-

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Phase represents the current phase of PersistentVolumeClaim.

false

string

accessModes

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

false

v1.PersistentVolumeAccessMode array

capacity

Represents the actual resources of the underlying volume.

false

object

- -
-
-

v1.UniqueVolumeName

- -
-
-

unversioned.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

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

false

unversioned.LabelSelectorRequirement array

- -
-
-

v1.EndpointSubset

-
-

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- }
-The resulting set of endpoints can be viewed as:
- a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
- b: [ 10.10.1.1:309, 10.10.2.2:309 ]

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

addresses

IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

false

v1.EndpointAddress array

notReadyAddresses

IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

false

v1.EndpointAddress array

ports

Port numbers available on the related IP addresses.

false

v1.EndpointPort array

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

- -
-
-

v1.FlexVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

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

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

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

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

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

false

v1.SecretKeySelector

- -
-
-

v1.Scale

-
-

Scale represents a scaling request for a resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.ScaleSpec

status

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

false

v1.ScaleStatus

- -
-
-

v1.LoadBalancerIngress

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

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

false

string

hostname

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

false

string

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

- -
-
-

v1.Service

-
-

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.ServiceSpec

status

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

false

v1.ServiceStatus

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.ServiceAccountList

-
-

ServiceAccountList is a list of ServiceAccount objects

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.ServiceAccount array

- -
-
-

v1.LimitRangeList

-
-

LimitRangeList is a list of LimitRange items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.LimitRange array

- -
-
-

v1.Endpoints

-
-

Endpoints is a collection of endpoints that implement the actual service. Example:
- Name: "mysvc",
- Subsets: [
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- },
- {
- Addresses: [{"ip": "10.10.3.3"}],
- Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
- },
- ]

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

subsets

The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

true

v1.EndpointSubset array

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

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

false

v1.Preconditions

orphanDependents

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

false

boolean

false

- -
-
-

v1.Volume

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

emptyDir

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

false

v1.EmptyDirVolumeSource

gcePersistentDisk

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

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

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

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

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

false

v1.SecretVolumeSource

nfs

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

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/examples/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

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

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

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

false

v1.PersistentVolumeClaimVolumeSource

rbd

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

false

v1.RBDVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

cinder

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

false

v1.CinderVolumeSource

cephfs

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

false

v1.CephFSVolumeSource

flocker

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

false

v1.FlockerVolumeSource

downwardAPI

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

false

v1.DownwardAPIVolumeSource

fc

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

false

v1.FCVolumeSource

azureFile

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

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

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

false

v1.VsphereVirtualDiskVolumeSource

- -
-
-

v1.ResourceFieldSelector

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

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

false

string

- -
-
-

v1.Probe

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

initialDelaySeconds

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

false

integer (int32)

timeoutSeconds

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

false

integer (int32)

periodSeconds

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

false

integer (int32)

successThreshold

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

false

integer (int32)

failureThreshold

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

false

integer (int32)

- -
-
-

unversioned.APIResourceList

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

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

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

key

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

true

string

- -
-
-

v1.ReplicationController

-
-

ReplicationController represents the configuration of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

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

false

v1.ReplicationControllerSpec

status

Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.ReplicationControllerStatus

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

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

true

string

- -
-
-

v1.PodStatus

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

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

false

string

conditions

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

false

v1.PodCondition array

message

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

false

string

reason

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

false

string

hostIP

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

false

string

podIP

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

false

string

startTime

RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

false

string

containerStatuses

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

false

v1.ContainerStatus array

- -
-
-

v1.LimitRange

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.LimitRangeSpec

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

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

true

string

fieldRef

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

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

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

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/containers.md

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#restartpolicy

false

string

terminationGracePeriodSeconds

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

false

integer (int64)

activeDeadlineSeconds

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

false

integer (int64)

dnsPolicy

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

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.3/docs/user-guide/node-selection/README.md

false

object

serviceAccountName

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

false

string

serviceAccount

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

false

string

nodeName

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

false

string

hostNetwork

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

false

boolean

false

hostPID

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

false

boolean

false

hostIPC

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

false

boolean

false

securityContext

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

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

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

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

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

true

integer (int32)

protocol

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

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.ResourceQuota

-
-

ResourceQuota sets aggregate quota restrictions enforced per namespace

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.ResourceQuotaSpec

status

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

false

v1.ResourceQuotaStatus

- -
-
-

v1.EventList

-
-

EventList is a list of events.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of events

true

v1.Event array

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.3/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.3/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

- -
-
-

v1.ReplicationControllerSpec

-
-

ReplicationControllerSpec is the specification of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

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

false

integer (int32)

selector

Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors

false

object

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md#pod-template

false

v1.PodTemplateSpec

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

- -
-
-

v1.NodeStatus

-
-

NodeStatus is information about the current status of a node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capacity

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

false

object

allocatable

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

false

object

phase

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

false

string

conditions

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

false

v1.NodeCondition array

addresses

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

false

v1.NodeAddress array

daemonEndpoints

Endpoints of daemons running on the Node.

false

v1.NodeDaemonEndpoints

nodeInfo

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

false

v1.NodeSystemInfo

images

List of container images on this node

false

v1.ContainerImage array

volumesInUse

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

false

v1.UniqueVolumeName array

volumesAttached

List of volumes that are attached to the node.

false

v1.AttachedVolume array

- -
-
-

v1.GlusterfsVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

- -
-
-

v1.AttachedVolume

-
-

AttachedVolume describes a volume attached to a node

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the attached volume

true

string

devicePath

DevicePath represents the device path where the volume should be avilable

true

string

- -
-
-

v1.EventSource

-
-

EventSource contains information for an event.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

component

Component from which the event is generated.

false

string

host

Host name on which the event is generated.

false

string

- -
-
-

v1.PodCondition

-
-

PodCondition contains details for the current condition of this pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

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

true

string

status

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

true

string

lastProbeTime

Last time we probed the condition.

false

string

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string

reason

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

false

string

message

Human-readable message indicating details about last transition.

false

string

- -
-
-

v1.RBDVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

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

true

string array

image

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

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#rbd

false

string

pool

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

false

string

user

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

false

string

keyring

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

- -
-
-

v1.PodTemplate

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

template

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

false

v1.PodTemplateSpec

- -
-
-

v1.ServiceStatus

-
-

ServiceStatus represents the current status of a service.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

loadBalancer

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

false

v1.LoadBalancerStatus

- -
-
-

v1.NFSVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target world wide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

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

false

boolean

false

- -
-
-

v1.EndpointPort

-
-

EndpointPort is a tuple that describes a single port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

port

The port number of the endpoint.

true

integer (int32)

protocol

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

false

string

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

group

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

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

causes

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

false

unversioned.StatusCause array

retryAfterSeconds

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

false

integer (int32)

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

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

false

string

scheme

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

false

string

httpHeaders

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

false

v1.HTTPHeader array

- -
-
-

v1.LoadBalancerStatus

-
-

LoadBalancerStatus represents the status of a load-balancer.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ingress

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

false

v1.LoadBalancerIngress array

- -
-
-

v1.SecretList

-
-

SecretList is a list of Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.Secret array

- -
-
-

v1.Container

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

image

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

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/containers.md#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/containers.md#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

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

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

volumeMounts

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

false

v1.VolumeMount array

livenessProbe

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

false

v1.Probe

readinessProbe

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

false

v1.Probe

lifecycle

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

false

v1.Lifecycle

terminationMessagePath

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

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/release-1.3/docs/design/security_context.md

false

v1.SecurityContext

stdin

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

false

boolean

false

stdinOnce

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

false

boolean

false

tty

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

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

supplementalGroups

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

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1.PersistentVolumeSpec

-
-

PersistentVolumeSpec is the specification of a persistent volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capacity

A description of the persistent volume’s resources and capacity. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#capacity

false

object

gcePersistentDisk

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

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

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

false

v1.AWSElasticBlockStoreVolumeSource

hostPath

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

false

v1.HostPathVolumeSource

glusterfs

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md

false

v1.GlusterfsVolumeSource

nfs

NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

false

v1.NFSVolumeSource

rbd

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

false

v1.RBDVolumeSource

iscsi

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.

false

v1.ISCSIVolumeSource

cinder

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

false

v1.CinderVolumeSource

cephfs

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

false

v1.CephFSVolumeSource

fc

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

false

v1.FCVolumeSource

flocker

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

false

v1.FlockerVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

azureFile

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

false

v1.AzureFileVolumeSource

vsphereVolume

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

false

v1.VsphereVirtualDiskVolumeSource

accessModes

AccessModes contains all ways the volume can be mounted. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#access-modes

false

v1.PersistentVolumeAccessMode array

claimRef

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

false

v1.ObjectReference

persistentVolumeReclaimPolicy

What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recyling must be supported by the volume plugin underlying this persistent volume. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#recycling-policy

false

string

- -
-
-

v1.ReplicationControllerStatus

-
-

ReplicationControllerStatus represents the current status of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

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

false

integer (int32)

observedGeneration

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

false

integer (int64)

- -
-
-

v1.FinalizerName

- -
-
-

v1.ServicePort

-
-

ServicePort contains information on service’s port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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.

false

string

protocol

The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.

false

string

port

The port that will be exposed by this service.

true

integer (int32)

targetPort

Number 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: http://releases.k8s.io/release-1.3/docs/user-guide/services.md#defining-a-service

false

string

nodePort

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: http://releases.k8s.io/release-1.3/docs/user-guide/services.md#type—nodeport

false

integer (int32)

- -
-
-

v1.ComponentCondition

-
-

Information about the condition of a component.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of condition for a component. Valid value: "Healthy"

true

string

status

Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

true

string

message

Message about the condition for a component. For example, information about a health check.

false

string

error

Condition error code for a component. For example, a health check error code.

false

string

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

true

string

name

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

true

string

uid

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

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

v1.ScaleSpec

-
-

ScaleSpec describes the attributes of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

- -
-
-

v1.ComponentStatusList

-
-

Status of all the conditions for the component as a list of ComponentStatus objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of ComponentStatus objects.

true

v1.ComponentStatus array

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#hostpath

true

string

- -
-
-

v1.ContainerStateTerminated

-
-

ContainerStateTerminated is a terminated state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exitCode

Exit status from the last termination of the container

true

integer (int32)

signal

Signal from the last termination of the container

false

integer (int32)

reason

(brief) reason from the last termination of the container

false

string

message

Message regarding the last termination of the container

false

string

startedAt

Time at which previous execution of the container started

false

string

finishedAt

Time at which the container last terminated

false

string

containerID

Container’s ID in the format docker://<container_id>

false

string

- -
-
-

v1.Binding

-
-

Binding ties one object to another. For example, a pod is bound to a node by a scheduler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

target

The target object that you want to bind to the standard object.

true

v1.ObjectReference

- -
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.ContainerState

-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

waiting

Details about a waiting container

false

v1.ContainerStateWaiting

running

Details about a running container

false

v1.ContainerStateRunning

terminated

Details about a terminated container

false

v1.ContainerStateTerminated

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

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

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

- -
-
-

v1.ContainerStatus

-
-

ContainerStatus contains details for the current status of this container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

state

Details about the container’s current condition.

false

v1.ContainerState

lastState

Details about the container’s last termination condition.

false

v1.ContainerState

ready

Specifies whether the container has passed its readiness probe.

true

boolean

false

restartCount

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.

true

integer (int32)

image

The image the container is running. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md

true

string

imageID

ImageID of the container’s image.

true

string

containerID

Container’s ID in the format docker://<container_id>. More info: http://releases.k8s.io/release-1.3/docs/user-guide/container-environment.md#container-information

false

string

- -
-
-

v1.ContainerImage

-
-

Describe a container image

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

names

Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]

true

string array

sizeBytes

The size of the image in bytes.

false

integer (int64)

- -
-
-

v1.ResourceQuotaScope

- -
-
-

v1.ReplicationControllerList

-
-

ReplicationControllerList is a collection of replication controllers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of replication controllers. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md

true

v1.ReplicationController array

- -
-
-

v1.NodeDaemonEndpoints

-
-

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kubeletEndpoint

Endpoint on which Kubelet is listening.

false

v1.DaemonEndpoint

- -
-
-

v1.Secret

-
-

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

data

Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. 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

false

object

type

Used to facilitate programmatic handling of secret data.

false

string

- -
-
-

v1.Event

-
-

Event is a report of an event somewhere in the cluster.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

true

v1.ObjectMeta

involvedObject

The object that this event is about.

true

v1.ObjectReference

reason

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

false

string

message

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

false

string

source

The component reporting this event. Should be a short machine understandable string.

false

v1.EventSource

firstTimestamp

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

false

string

lastTimestamp

The time at which the most recent occurrence of this event was recorded.

false

string

count

The number of times this event has occurred.

false

integer (int32)

type

Type of this event (Normal, Warning), new types could be added in the future

false

string

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

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

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.PersistentVolumeAccessMode

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://releases.k8s.io/release-1.3/docs/design/resources.md#resource-specifications

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/release-1.3/docs/design/resources.md#resource-specifications

false

object

- -
-
-

v1.ComponentStatus

-
-

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

conditions

List of component conditions observed

false

v1.ComponentCondition array

- -
-
-

v1.LimitRangeItem

-
-

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of resource that this limit applies to.

false

string

max

Max usage constraints on this kind by resource name.

false

object

min

Min usage constraints on this kind by resource name.

false

object

default

Default resource requirement limit value by resource name if resource limit is omitted.

false

object

defaultRequest

DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

false

object

maxLimitRequestRatio

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.

false

object

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PodSpec

- -
-
-

v1.PodList

-
-

PodList is a list of Pods.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of pods. More info: http://releases.k8s.io/release-1.3/docs/user-guide/pods.md

true

v1.Pod array

- -
-
-

v1.ServiceList

-
-

ServiceList holds a list of services.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of services

true

v1.Service array

- -
-
-

v1.PersistentVolumeList

-
-

PersistentVolumeList is a list of PersistentVolume items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of persistent volumes. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md

true

v1.PersistentVolume array

- -
-
-

v1.ObjectReference

-
-

ObjectReference contains enough information to let you inspect or modify the referred object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

namespace

Namespace of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

false

string

name

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

false

string

uid

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

false

string

apiVersion

API version of the referent.

false

string

resourceVersion

Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

fieldPath

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.

false

string

- -
-
-

unversioned.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

v1.ContainerStateWaiting

-
-

ContainerStateWaiting is a waiting state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

(brief) reason the container is not yet running.

false

string

message

Message regarding why the container is not yet running.

false

string

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

string

message

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

false

string

reason

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

false

string

details

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

false

unversioned.StatusDetails

code

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

false

integer (int32)

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

key

The key to select.

true

string

- -
-
-

v1.NodeSystemInfo

-
-

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

machineID

Machine ID reported by the node.

true

string

systemUUID

System UUID reported by the node.

true

string

bootID

Boot ID reported by the node.

true

string

kernelVersion

Kernel Version reported by the node from uname -r (e.g. 3.16.0-0.bpo.4-amd64).

true

string

osImage

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

true

string

containerRuntimeVersion

ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

true

string

kubeletVersion

Kubelet Version reported by the node.

true

string

kubeProxyVersion

KubeProxy Version reported by the node.

true

string

operatingSystem

The Operating System reported by the node

true

string

architecture

The Architecture reported by the node

true

string

- -
-
-

v1.ServiceSpec

-
-

ServiceSpec describes the attributes that a user creates on a service.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ports

The list of ports that are exposed by this service. More info: http://releases.k8s.io/release-1.3/docs/user-guide/services.md#virtual-ips-and-service-proxies

true

v1.ServicePort array

selector

This service will route traffic to pods having labels matching this selector. Label keys and values that must match in order to receive traffic for this service. If empty, all pods are selected, if not specified, endpoints must be manually specified. More info: http://releases.k8s.io/release-1.3/docs/user-guide/services.md#overview

false

object

clusterIP

ClusterIP is usually assigned by the master and is the IP address of the service. If specified, it will be allocated to the service if it is unused or else creation of the service will fail. Valid values are None, empty string (""), or a valid IP address. None can be specified for a headless service when proxying is not required. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

type

Type of exposed service. Must be ClusterIP, NodePort, or LoadBalancer. Defaults to ClusterIP. More info: http://releases.k8s.io/release-1.3/docs/user-guide/services.md#external-services

false

string

externalIPs

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. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.

false

string array

deprecatedPublicIPs

deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.

false

string array

sessionAffinity

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: http://releases.k8s.io/release-1.3/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

loadBalancerIP

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.

false

string

loadBalancerSourceRanges

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

false

string array

- -
-
-

v1.Pod

-
-

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PodSpec

status

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

false

v1.PodStatus

- -
-
-

v1.NodeSpec

-
-

NodeSpec describes the attributes that a node is created with.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podCIDR

PodCIDR represents the pod IP range assigned to the node.

false

string

externalID

External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.

false

string

providerID

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

false

string

unschedulable

Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/release-1.3/docs/admin/node.md#manual-node-administration"`

false

boolean

false

- -
-
-

v1.EndpointAddress

-
-

EndpointAddress is a tuple that describes single IP address.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

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.

true

string

hostname

The Hostname of this endpoint

false

string

targetRef

Reference to object providing the endpoint.

false

v1.ObjectReference

- -
-
-

v1.DaemonEndpoint

-
-

DaemonEndpoint contains information about a single Daemon endpoint.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

Port

Port number of the given endpoint.

true

integer (int32)

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.3/v1-operations.html b/_includes/v1.3/v1-operations.html deleted file mode 100755 index 515d4e7fa1e6a..0000000000000 --- a/_includes/v1.3/v1-operations.html +++ /dev/null @@ -1,32321 +0,0 @@ - - - - - - -Operations - - - -
-
-

Operations

-
-
-

get available resources

-
-
-
GET /api/v1
-
-
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

unversioned.APIResourceList

- -
-
-

Consumes

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list objects of kind ComponentStatus

-
-
-
GET /api/v1/componentstatuses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ComponentStatusList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ComponentStatus

-
-
-
GET /api/v1/componentstatuses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the ComponentStatus

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ComponentStatus

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ConfigMap

-
-
-
GET /api/v1/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMapList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Endpoints

-
-
-
GET /api/v1/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EndpointsList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Event

-
-
-
GET /api/v1/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EventList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind LimitRange

-
-
-
GET /api/v1/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRangeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Namespace

-
-
-
GET /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.NamespaceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Namespace

-
-
-
DELETE /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Namespace

-
-
-
POST /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Binding

-
-
-
POST /api/v1/namespaces/{namespace}/bindings
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Binding

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ConfigMap

-
-
-
GET /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMapList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ConfigMap

-
-
-
DELETE /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ConfigMap

-
-
-
POST /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ConfigMap

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ConfigMap

-
-
-
GET /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ConfigMap

-
-
-
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ConfigMap

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ConfigMap

-
-
-
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ConfigMap

-
-
-
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Endpoints

-
-
-
GET /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EndpointsList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Endpoints

-
-
-
DELETE /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create an Endpoints

-
-
-
POST /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Endpoints

-
-
-
GET /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Endpoints

-
-
-
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete an Endpoints

-
-
-
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Endpoints

-
-
-
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Event

-
-
-
GET /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EventList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Event

-
-
-
DELETE /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create an Event

-
-
-
POST /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Event

-
-
-
GET /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Event

-
-
-
PUT /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete an Event

-
-
-
DELETE /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Event

-
-
-
PATCH /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind LimitRange

-
-
-
GET /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRangeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of LimitRange

-
-
-
DELETE /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a LimitRange

-
-
-
POST /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified LimitRange

-
-
-
GET /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified LimitRange

-
-
-
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a LimitRange

-
-
-
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified LimitRange

-
-
-
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaimList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PersistentVolumeClaim

-
-
-
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PersistentVolumeClaim

-
-
-
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PersistentVolumeClaim

-
-
-
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PersistentVolumeClaim

-
-
-
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PersistentVolumeClaim

-
-
-
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified PersistentVolumeClaim

-
-
-
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified PersistentVolumeClaim

-
-
-
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Pod

-
-
-
PATCH /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to attach of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to attach of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create binding of a Binding

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Binding

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Binding

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to exec of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to exec of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read log of the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/log
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

container

The container for which to stream logs. Defaults to only container if there is one container in the pod.

false

string

QueryParameter

follow

Follow the log stream of the pod. Defaults to false.

false

boolean

QueryParameter

previous

Return previous terminated container logs. Defaults to false.

false

boolean

QueryParameter

sinceSeconds

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

false

integer (int32)

QueryParameter

sinceTime

An RFC3339 timestamp 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.

false

string

QueryParameter

timestamps

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

false

boolean

QueryParameter

tailLines

If 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

false

integer (int32)

QueryParameter

limitBytes

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

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to portforward of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to portforward of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Pod

-
-
-
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PodTemplate

-
-
-
GET /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PodTemplate

-
-
-
DELETE /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PodTemplate

-
-
-
POST /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PodTemplate

-
-
-
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PodTemplate

-
-
-
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PodTemplate

-
-
-
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PodTemplate

-
-
-
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ReplicationController

-
-
-
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ReplicationController

-
-
-
POST /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ReplicationController

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ReplicationController

-
-
-
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ReplicationController

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified ReplicationController

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified ReplicationController

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ResourceQuota

-
-
-
DELETE /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ResourceQuota

-
-
-
POST /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ResourceQuota

-
-
-
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ResourceQuota

-
-
-
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ResourceQuota

-
-
-
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified ResourceQuota

-
-
-
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified ResourceQuota

-
-
-
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Secret

-
-
-
GET /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.SecretList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Secret

-
-
-
DELETE /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Secret

-
-
-
POST /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Secret

-
-
-
GET /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Secret

-
-
-
PUT /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Secret

-
-
-
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Secret

-
-
-
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ServiceAccount

-
-
-
GET /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ServiceAccount

-
-
-
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ServiceAccount

-
-
-
POST /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ServiceAccount

-
-
-
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ServiceAccount

-
-
-
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ServiceAccount

-
-
-
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ServiceAccount

-
-
-
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Service

-
-
-
GET /api/v1/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Service

-
-
-
POST /api/v1/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Service

-
-
-
PATCH /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Service

-
-
-
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Service

-
-
-
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

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

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Service

-
-
-
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Namespace

-
-
-
GET /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Namespace

-
-
-
DELETE /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Namespace

-
-
-
PATCH /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace finalize of the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}/finalize
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Namespace

-
-
-
GET /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Namespace

-
-
-
PATCH /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Node

-
-
-
GET /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.NodeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Node

-
-
-
DELETE /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Node

-
-
-
POST /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Node

-
-
-
GET /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Node

-
-
-
PUT /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Node

-
-
-
DELETE /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Node

-
-
-
PATCH /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Node

-
-
-
GET /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Node

-
-
-
PUT /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Node

-
-
-
DELETE /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Node

-
-
-
POST /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Node

-
-
-
GET /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Node

-
-
-
PUT /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Node

-
-
-
DELETE /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Node

-
-
-
POST /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Node

-
-
-
GET /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Node

-
-
-
PUT /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Node

-
-
-
PATCH /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolumeClaim

-
-
-
GET /api/v1/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaimList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolume

-
-
-
GET /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PersistentVolume

-
-
-
DELETE /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PersistentVolume

-
-
-
POST /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PersistentVolume

-
-
-
GET /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PersistentVolume

-
-
-
PUT /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PersistentVolume

-
-
-
DELETE /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PersistentVolume

-
-
-
PATCH /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified PersistentVolume

-
-
-
GET /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified PersistentVolume

-
-
-
PUT /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified PersistentVolume

-
-
-
PATCH /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Pod

-
-
-
GET /api/v1/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PodTemplate

-
-
-
GET /api/v1/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Pod

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Pod

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Pod

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Pod

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Pod

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Pod

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Pod

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Pod

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Service

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Service

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Service

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Service

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Service

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Service

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Service

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Service

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Node

-
-
-
GET /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Node

-
-
-
PUT /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Node

-
-
-
DELETE /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Node

-
-
-
POST /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Node

-
-
-
GET /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Node

-
-
-
PUT /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Node

-
-
-
DELETE /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Node

-
-
-
POST /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicationController

-
-
-
GET /api/v1/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ResourceQuota

-
-
-
GET /api/v1/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Secret

-
-
-
GET /api/v1/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.SecretList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ServiceAccount

-
-
-
GET /api/v1/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Service

-
-
-
GET /api/v1/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ConfigMap

-
-
-
GET /api/v1/watch/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Endpoints

-
-
-
GET /api/v1/watch/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Event

-
-
-
GET /api/v1/watch/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of LimitRange

-
-
-
GET /api/v1/watch/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Namespace

-
-
-
GET /api/v1/watch/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ConfigMap

-
-
-
GET /api/v1/watch/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ConfigMap

-
-
-
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Endpoints

-
-
-
GET /api/v1/watch/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Endpoints

-
-
-
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Event

-
-
-
GET /api/v1/watch/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Event

-
-
-
GET /api/v1/watch/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of LimitRange

-
-
-
GET /api/v1/watch/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind LimitRange

-
-
-
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolumeClaim

-
-
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PersistentVolumeClaim

-
-
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Pod

-
-
-
GET /api/v1/watch/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Pod

-
-
-
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PodTemplate

-
-
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PodTemplate

-
-
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicationController

-
-
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ReplicationController

-
-
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ResourceQuota

-
-
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ResourceQuota

-
-
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Secret

-
-
-
GET /api/v1/watch/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Secret

-
-
-
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ServiceAccount

-
-
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ServiceAccount

-
-
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Service

-
-
-
GET /api/v1/watch/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Service

-
-
-
GET /api/v1/watch/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Namespace

-
-
-
GET /api/v1/watch/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Node

-
-
-
GET /api/v1/watch/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Node

-
-
-
GET /api/v1/watch/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolumeClaim

-
-
-
GET /api/v1/watch/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolume

-
-
-
GET /api/v1/watch/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PersistentVolume

-
-
-
GET /api/v1/watch/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Pod

-
-
-
GET /api/v1/watch/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PodTemplate

-
-
-
GET /api/v1/watch/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicationController

-
-
-
GET /api/v1/watch/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ResourceQuota

-
-
-
GET /api/v1/watch/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Secret

-
-
-
GET /api/v1/watch/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ServiceAccount

-
-
-
GET /api/v1/watch/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Service

-
-
-
GET /api/v1/watch/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.4/extensions-v1beta1-definitions.html b/_includes/v1.4/extensions-v1beta1-definitions.html deleted file mode 100755 index 17ce326c93390..0000000000000 --- a/_includes/v1.4/extensions-v1beta1-definitions.html +++ /dev/null @@ -1,6209 +0,0 @@ - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1beta1.DeploymentStatus

-
-

DeploymentStatus is the most recently observed status of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

The generation observed by the deployment controller.

false

integer (int64)

replicas

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

false

integer (int32)

updatedReplicas

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

false

integer (int32)

availableReplicas

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

false

integer (int32)

unavailableReplicas

Total number of unavailable pods targeted by this deployment.

false

integer (int32)

- -
-
-

v1beta1.DaemonSetStatus

-
-

DaemonSetStatus represents the current status of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

currentNumberScheduled

CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/release-1.4/docs/admin/daemons.md

true

integer (int32)

numberMisscheduled

NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/release-1.4/docs/admin/daemons.md

true

integer (int32)

desiredNumberScheduled

DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/release-1.4/docs/admin/daemons.md

true

integer (int32)

- -
-
-

v1beta1.Job

-
-

Job represents the configuration of a single job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobSpec

status

Status is a structure describing current status of a job. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobStatus

- -
-
-

v1.Preconditions

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

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

false

string

fieldPath

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

true

string

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

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

false

string

role

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

false

string

type

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

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

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

false

boolean

false

mountPath

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

true

string

subPath

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

false

string

- -
-
-

v1beta1.IngressSpec

-
-

IngressSpec describes the Ingress the user wishes to exist.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

backend

A default backend capable of servicing requests that don’t match any rule. At least one of backend or rules must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.

false

v1beta1.IngressBackend

tls

TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

false

v1beta1.IngressTLS array

rules

A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

false

v1beta1.IngressRule array

- -
-
-

v1beta1.IngressBackend

-
-

IngressBackend describes all endpoints for a given service and port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

serviceName

Specifies the name of the referenced service.

true

string

servicePort

Specifies the port of the referenced service.

true

string

- -
-
-

v1beta1.ReplicaSetList

-
-

ReplicaSetList is a collection of ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of ReplicaSets. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md

true

v1beta1.ReplicaSet array

- -
-
-

v1.CephFSVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

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

true

string array

path

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

false

string

user

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

false

string

secretFile

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

- -
-
-

v1beta1.IngressStatus

-
-

IngressStatus describe the current state of the Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

loadBalancer

LoadBalancer contains the current status of the load-balancer.

false

v1.LoadBalancerStatus

- -
-
-

v1.DownwardAPIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusCause

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

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

false

string

message

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

false

string

field

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

false

string

- -
-
-

v1beta1.NetworkPolicyList

-
-

Network Policy List is a list of NetworkPolicy objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of schema objects.

true

v1beta1.NetworkPolicy array

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

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

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

readOnly

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

false

boolean

false

- -
-
-

v1beta1.RollingUpdateDeployment

-
-

Spec to control the desired behavior of rolling update.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

maxUnavailable

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

false

string

maxSurge

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.

false

string

- -
-
-

v1beta1.HTTPIngressRuleValue

-
-

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

paths

A collection of paths that map requests to backends.

true

v1beta1.HTTPIngressPath array

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

*versioned.Event

- -
-
-

v1beta1.JobStatus

-
-

JobStatus represents the current state of a Job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

conditions

Conditions represent the latest available observations of an object’s current state. More info: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md

false

v1beta1.JobCondition array

startTime

StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

completionTime

CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

active

Active is the number of actively running pods.

false

integer (int32)

succeeded

Succeeded is the number of pods which reached Phase Succeeded.

false

integer (int32)

failed

Failed is the number of pods which reached Phase Failed.

false

integer (int32)

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.LocalObjectReference

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.ObjectMeta

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

false

string

selfLink

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

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

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

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

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

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

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

false

string

- -
-
-

v1beta1.ReplicaSetSpec

-
-

ReplicaSetSpec is the specification of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

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

false

integer (int32)

selector

Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

v1beta1.LabelSelector

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#pod-template

false

v1.PodTemplateSpec

- -
-
-

v1beta1.DaemonSetSpec

-
-

DaemonSetSpec is the specification of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selector

Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

v1beta1.LabelSelector

template

Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#pod-template

true

v1.PodTemplateSpec

- -
-
-

v1beta1.Deployment

-
-

Deployment enables declarative updates for Pods and ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata.

false

v1.ObjectMeta

spec

Specification of the desired behavior of the Deployment.

false

v1beta1.DeploymentSpec

status

Most recently observed status of the Deployment.

false

v1beta1.DeploymentStatus

- -
-
-

v1.AzureFileVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

true

string

shareName

Share Name

true

string

readOnly

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

false

boolean

false

- -
-
-

types.UID

- -
-
-

v1.ISCSIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

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

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

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

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#iscsi

false

string

readOnly

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

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#emptydir

false

string

- -
-
-

v1beta1.IngressList

-
-

IngressList is a collection of Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of Ingress.

true

v1beta1.Ingress array

- -
-
-

v1beta1.ScaleSpec

-
-

describes the attributes of a scale subresource

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

- -
-
-

unversioned.Patch

-
-

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

-
-
-
-

v1.FlockerVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

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

true

string

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

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

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

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

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1beta1.HorizontalPodAutoscaler

-
-

configuration of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

behaviour of autoscaler. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status.

false

v1beta1.HorizontalPodAutoscalerSpec

status

current information about the autoscaler.

false

v1beta1.HorizontalPodAutoscalerStatus

- -
-
-

v1beta1.RollbackConfig

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

revision

The revision to rollback to. If set to 0, rollbck to the last revision.

false

integer (int64)

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

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

false

v1.SecretKeySelector

- -
-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

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

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1beta1.JobCondition

-
-

JobCondition describes current state of a job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of job condition, Complete or Failed.

true

string

status

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

true

string

lastProbeTime

Last time the condition was checked.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.LoadBalancerIngress

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

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

false

string

hostname

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

false

string

- -
-
-

v1beta1.APIVersion

-
-

An APIVersion represents a single concrete version of an object model.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of this version (e.g. v1).

false

string

- -
-
-

v1.AzureDiskVolumeSource

-
-

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

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

false

boolean

false

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

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

false

v1.Preconditions

orphanDependents

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

false

boolean

false

- -
-
-

v1.Volume

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

emptyDir

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

false

v1.EmptyDirVolumeSource

gcePersistentDisk

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

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

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

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

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

false

v1.SecretVolumeSource

nfs

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

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.4/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

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

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

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

false

v1.PersistentVolumeClaimVolumeSource

rbd

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

false

v1.RBDVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

cinder

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

false

v1.CinderVolumeSource

cephfs

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

false

v1.CephFSVolumeSource

flocker

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

false

v1.FlockerVolumeSource

downwardAPI

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

false

v1.DownwardAPIVolumeSource

fc

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

false

v1.FCVolumeSource

azureFile

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

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

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

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

- -
-
-

v1beta1.DaemonSetList

-
-

DaemonSetList is a collection of daemon sets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of daemon sets.

true

v1beta1.DaemonSet array

- -
-
-

v1.ResourceFieldSelector

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

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

false

string

- -
-
-

v1.Probe

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

initialDelaySeconds

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

false

integer (int32)

timeoutSeconds

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

false

integer (int32)

periodSeconds

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

false

integer (int32)

successThreshold

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

false

integer (int32)

failureThreshold

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

false

integer (int32)

- -
-
-

v1beta1.DeploymentSpec

-
-

DeploymentSpec is the specification of the desired behavior of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

false

integer (int32)

selector

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

false

v1beta1.LabelSelector

template

Template describes the pods that will be created.

true

v1.PodTemplateSpec

strategy

The deployment strategy to use to replace existing pods with new ones.

false

v1beta1.DeploymentStrategy

minReadySeconds

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

false

integer (int32)

revisionHistoryLimit

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.

false

integer (int32)

paused

Indicates that the deployment is paused and will not be processed by the deployment controller.

false

boolean

false

rollbackTo

The config this deployment is rolling back to. Will be cleared after rollback is done.

false

v1beta1.RollbackConfig

- -
-
-

unversioned.APIResourceList

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

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

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

key

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

true

string

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

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

true

string

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

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

true

string

fieldRef

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

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

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

true

integer (int32)

protocol

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

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

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

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#restartpolicy

false

string

terminationGracePeriodSeconds

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

false

integer (int64)

activeDeadlineSeconds

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

false

integer (int64)

dnsPolicy

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

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/node-selection/README.md

false

object

serviceAccountName

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

false

string

serviceAccount

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

false

string

nodeName

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

false

string

hostNetwork

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

false

boolean

false

hostPID

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

false

boolean

false

hostIPC

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

false

boolean

false

securityContext

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

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

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

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

- -
-
-

v1.GlusterfsVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

- -
-
-

v1beta1.IngressTLS

-
-

IngressTLS describes the transport layer security associated with an Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hosts

Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.

false

string array

secretName

SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

false

string

- -
-
-

v1beta1.SubresourceReference

-
-

SubresourceReference contains enough information to let you inspect or modify the referred subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent; More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

name

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

false

string

apiVersion

API version of the referent

false

string

subresource

Subresource name of the referent

false

string

- -
-
-

v1beta1.Scale

-
-

represents a scaling request for a resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.ScaleSpec

status

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

false

v1beta1.ScaleStatus

- -
-
-

v1.RBDVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

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

true

string array

image

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

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd

false

string

pool

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

false

string

user

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

false

string

keyring

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

- -
-
-

v1beta1.NetworkPolicy

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

Specification of the desired behavior for this NetworkPolicy.

false

v1beta1.NetworkPolicySpec

- -
-
-

v1beta1.ScaleStatus

-
-

represents the current status of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

label query over pods that should match the replicas count. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

object

targetSelector

label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

string

- -
-
-

v1beta1.NetworkPolicySpec

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.

true

v1beta1.LabelSelector

ingress

List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list.

false

v1beta1.NetworkPolicyIngressRule array

- -
-
-

v1.NFSVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

- -
-
-

v1beta1.DeploymentList

-
-

DeploymentList is a list of Deployments.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of Deployments.

true

v1beta1.Deployment array

- -
-
-

v1beta1.DeploymentRollback

-
-

DeploymentRollback stores the information required to rollback a deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

name

Required: This must match the Name of a deployment.

true

string

updatedAnnotations

The annotations to be updated to a deployment

false

object

rollbackTo

The config of this deployment rollback.

true

v1beta1.RollbackConfig

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1beta1.HorizontalPodAutoscalerStatus

-
-

current status of a horizontal pod autoscaler

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

most recent generation observed by this autoscaler.

false

integer (int64)

lastScaleTime

last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.

false

string (date-time)

currentReplicas

current number of replicas of pods managed by this autoscaler.

true

integer (int32)

desiredReplicas

desired number of replicas of pods managed by this autoscaler.

true

integer (int32)

currentCPUUtilizationPercentage

current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.

false

integer (int32)

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

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

false

boolean

false

- -
-
-

v1beta1.ThirdPartyResource

-
-

A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata

false

v1.ObjectMeta

description

Description is the description of this object.

false

string

versions

Versions are versions for this third party object

false

v1beta1.APIVersion array

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

v1beta1.DeploymentStrategy

-
-

DeploymentStrategy describes how to replace existing pods with new ones.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

false

string

rollingUpdate

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

false

v1beta1.RollingUpdateDeployment

- -
-
-

v1beta1.IngressRule

-
-

IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

host

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
- 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.

false

string

http

false

v1beta1.HTTPIngressRuleValue

- -
-
-

v1beta1.JobList

-
-

JobList is a collection of jobs.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of Job.

true

v1beta1.Job array

- -
-
-

v1beta1.NetworkPolicyPeer

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.

false

v1beta1.LabelSelector

namespaceSelector

Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.

false

v1beta1.LabelSelector

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

group

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

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

causes

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

false

unversioned.StatusCause array

retryAfterSeconds

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

false

integer (int32)

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

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

false

string

scheme

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

false

string

httpHeaders

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

false

v1.HTTPHeader array

- -
-
-

v1beta1.CPUTargetUtilization

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPercentage

fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use.

true

integer (int32)

- -
-
-

v1.LoadBalancerStatus

-
-

LoadBalancerStatus represents the status of a load-balancer.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ingress

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

false

v1.LoadBalancerIngress array

- -
-
-

v1.Container

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

image

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

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

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

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

volumeMounts

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

false

v1.VolumeMount array

livenessProbe

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

false

v1.Probe

readinessProbe

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

false

v1.Probe

lifecycle

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

false

v1.Lifecycle

terminationMessagePath

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

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/release-1.4/docs/design/security_context.md

false

v1.SecurityContext

stdin

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

false

boolean

false

stdinOnce

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

false

boolean

false

tty

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

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

supplementalGroups

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

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1beta1.NetworkPolicyIngressRule

-
-

This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ports

List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.

false

v1beta1.NetworkPolicyPort array

from

List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.

false

v1beta1.NetworkPolicyPeer array

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

true

string

name

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

true

string

uid

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

v1beta1.ReplicaSetStatus

-
-

ReplicaSetStatus represents the current status of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

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

false

integer (int32)

readyReplicas

The number of ready replicas for this replica set.

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

false

integer (int64)

- -
-
-

v1beta1.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

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

false

v1beta1.LabelSelectorRequirement array

- -
-
-

v1beta1.ReplicaSet

-
-

ReplicaSet represents the configuration of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

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

false

v1beta1.ReplicaSetSpec

status

Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.ReplicaSetStatus

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

true

string

- -
-
-

v1beta1.DaemonSet

-
-

DaemonSet represents the configuration of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.DaemonSetSpec

status

Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.DaemonSetStatus

- -
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

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

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.Protocol

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

- -
-
-

v1beta1.HorizontalPodAutoscalerSpec

-
-

specification of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

scaleRef

reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec.

true

v1beta1.SubresourceReference

minReplicas

lower limit for the number of pods that can be set by the autoscaler, default 1.

false

integer (int32)

maxReplicas

upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

true

integer (int32)

cpuUtilization

target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources.

false

v1beta1.CPUTargetUtilization

- -
-
-

v1.QuobyteVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

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

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

- -
-
-

v1beta1.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

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

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

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

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

- -
-
-

v1beta1.NetworkPolicyPort

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

protocol

Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

false

v1.Protocol

port

If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.

false

string

- -
-
-

v1beta1.JobSpec

-
-

JobSpec describes how the job execution will look like.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

parallelism

Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md

false

integer (int32)

completions

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md

false

integer (int32)

activeDeadlineSeconds

Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

false

integer (int64)

selector

Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

v1beta1.LabelSelector

autoSelector

AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/release-1.4/docs/design/selector-generation.md

false

boolean

false

template

Template is the object that describes the pod that will be created when executing a job. More info: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md

true

v1.PodTemplateSpec

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

string

message

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

false

string

reason

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

false

string

details

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

false

unversioned.StatusDetails

code

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

false

integer (int32)

- -
-
-

v1beta1.HorizontalPodAutoscalerList

-
-

list of horizontal pod autoscaler objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

list of horizontal pod autoscaler objects.

true

v1beta1.HorizontalPodAutoscaler array

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

key

The key to select.

true

string

- -
-
-

v1beta1.HTTPIngressPath

-
-

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e. this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend.

false

string

backend

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

true

v1beta1.IngressBackend

- -
-
-

v1beta1.Ingress

-
-

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec is the desired state of the Ingress. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.IngressSpec

status

Status is the current state of the Ingress. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.IngressStatus

- -
-
-

v1beta1.ThirdPartyResourceList

-
-

ThirdPartyResourceList is a list of ThirdPartyResources.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of ThirdPartyResources.

true

v1beta1.ThirdPartyResource array

- -
-
-

v1.AzureDataDiskCachingMode

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.4/extensions-v1beta1-operations.html b/_includes/v1.4/extensions-v1beta1-operations.html deleted file mode 100755 index b64aa1cfe93dc..0000000000000 --- a/_includes/v1.4/extensions-v1beta1-operations.html +++ /dev/null @@ -1,15661 +0,0 @@ - - - - - - -Operations - - - -
-
-

Operations

-
-
-

get available resources

-
-
-
GET /apis/extensions/v1beta1
-
-
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

unversioned.APIResourceList

- -
-
-

Consumes

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscalerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.IngressList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Job

-
-
-
GET /apis/extensions/v1beta1/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.JobList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of DaemonSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a DaemonSet

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified DaemonSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a DaemonSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified DaemonSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified DaemonSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified DaemonSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Deployment

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a Deployment

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Deployment

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a Deployment

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Deployment

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create rollback of a DeploymentRollback

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DeploymentRollback

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DeploymentRollback

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentRollback

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Deployment

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Deployment

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscalerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of HorizontalPodAutoscaler

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a HorizontalPodAutoscaler

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified HorizontalPodAutoscaler

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a HorizontalPodAutoscaler

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified HorizontalPodAutoscaler

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified HorizontalPodAutoscaler

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified HorizontalPodAutoscaler

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.IngressList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Ingress

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create an Ingress

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Ingress

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete an Ingress

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Ingress

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Ingress

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Ingress

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.JobList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Job

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a Job

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Job

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a Job

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Job

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Job

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Job

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicyList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of NetworkPolicy

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a NetworkPolicy

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.NetworkPolicy

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified NetworkPolicy

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.NetworkPolicy

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a NetworkPolicy

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified NetworkPolicy

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of ReplicaSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a ReplicaSet

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified ReplicaSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a ReplicaSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified ReplicaSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified ReplicaSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified ReplicaSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicyList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResourceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of ThirdPartyResource

-
-
-
DELETE /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a ThirdPartyResource

-
-
-
POST /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ThirdPartyResource

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified ThirdPartyResource

-
-
-
PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ThirdPartyResource

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a ThirdPartyResource

-
-
-
DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified ThirdPartyResource

-
-
-
PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Job

-
-
-
GET /apis/extensions/v1beta1/watch/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Job

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Job

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/watch/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/watch/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.4/v1-definitions.html b/_includes/v1.4/v1-definitions.html deleted file mode 100755 index 8e61a5b0406a2..0000000000000 --- a/_includes/v1.4/v1-definitions.html +++ /dev/null @@ -1,8087 +0,0 @@ - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1.Node

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.NodeSpec

status

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

false

v1.NodeStatus

- -
-
-

v1.PersistentVolumeClaimList

-
-

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.PersistentVolumeClaim array

- -
-
-

v1.Preconditions

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

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

false

string

role

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

false

string

type

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

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

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

false

string

fieldPath

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

true

string

- -
-
-

v1.ContainerStateRunning

-
-

ContainerStateRunning is a running state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

startedAt

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

false

string (date-time)

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

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

false

boolean

false

mountPath

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

true

string

subPath

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

false

string

- -
-
-

v1.PersistentVolumeClaimSpec

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

accessModes

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

false

v1.PersistentVolumeAccessMode array

selector

A label query over volumes to consider for binding.

false

unversioned.LabelSelector

resources

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

false

v1.ResourceRequirements

volumeName

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

false

string

- -
-
-

v1.CephFSVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

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

true

string array

path

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

false

string

user

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

false

string

secretFile

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

- -
-
-

v1.DownwardAPIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusCause

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

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

false

string

message

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

false

string

field

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

false

string

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

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

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

readOnly

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

false

boolean

false

- -
-
-

v1.ResourceQuotaSpec

-
-

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hard

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

false

object

scopes

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

false

v1.ResourceQuotaScope array

- -
-
-

v1.NamespaceStatus

-
-

NamespaceStatus is information about the current status of a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

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

false

string

- -
-
-

v1.NamespaceSpec

-
-

NamespaceSpec describes the attributes on a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

finalizers

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

false

v1.FinalizerName array

- -
-
-

v1.PersistentVolume

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PersistentVolumeSpec

status

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

false

v1.PersistentVolumeStatus

- -
-
-

v1.ConfigMapList

-
-

ConfigMapList is a resource containing a list of ConfigMap objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of ConfigMaps.

true

v1.ConfigMap array

- -
-
-

v1.PersistentVolumeStatus

-
-

PersistentVolumeStatus is the current status of a persistent volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

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

false

string

message

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

false

string

reason

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

false

string

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

*versioned.Event

- -
-
-

v1.EndpointsList

-
-

EndpointsList is a list of endpoints.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of endpoints.

true

v1.Endpoints array

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

v1.ScaleStatus

-
-

ScaleStatus represents the current status of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

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

false

string

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.ConfigMap

-
-

ConfigMap holds configuration data for pods to consume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

data

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

false

object

- -
-
-

v1.PodTemplateList

-
-

PodTemplateList is a list of PodTemplates.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of pod templates

true

v1.PodTemplate array

- -
-
-

v1.NodeCondition

-
-

NodeCondition contains condition information for a node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of node condition.

true

string

status

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

true

string

lastHeartbeatTime

Last time we got an update on a given condition.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.LocalObjectReference

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

false

string

- -
-
-

v1.ResourceQuotaStatus

-
-

ResourceQuotaStatus defines the enforced hard limits and observed use.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hard

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

false

object

used

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

false

object

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.ObjectMeta

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

false

string

selfLink

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

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

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

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

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

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

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

false

string

- -
-
-

v1.LimitRangeSpec

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits is the list of LimitRangeItem objects that are enforced.

true

v1.LimitRangeItem array

- -
-
-

types.UID

- -
-
-

v1.AzureFileVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

true

string

shareName

Share Name

true

string

readOnly

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

false

boolean

false

- -
-
-

v1.ISCSIVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

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

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

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

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#iscsi

false

string

readOnly

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

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#emptydir

false

string

- -
-
-

v1.NodeList

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

List of nodes

true

v1.Node array

- -
-
-

unversioned.Patch

-
-

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

-
-
-
-

v1.NamespaceList

-
-

NamespaceList is a list of Namespaces.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.Namespace array

- -
-
-

v1.PersistentVolumeClaim

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PersistentVolumeClaimSpec

status

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

false

v1.PersistentVolumeClaimStatus

- -
-
-

v1.ServiceAccount

-
-

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

secrets

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

false

v1.ObjectReference array

imagePullSecrets

ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://releases.k8s.io/release-1.4/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

false

v1.LocalObjectReference array

- -
-
-

v1.NodeAddress

-
-

NodeAddress contains information for the node’s address.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Node address type, one of Hostname, ExternalIP or InternalIP.

true

string

address

The node address.

true

string

- -
-
-

v1.Namespace

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.NamespaceSpec

status

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

false

v1.NamespaceStatus

- -
-
-

v1.FlockerVolumeSource

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

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

true

string

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

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

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

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

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1.ResourceQuotaList

-
-

ResourceQuotaList is a list of ResourceQuota items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.ResourceQuota array

- -
-
-

v1.PersistentVolumeClaimStatus

-
-

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Phase represents the current phase of PersistentVolumeClaim.

false

string

accessModes

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

false

v1.PersistentVolumeAccessMode array

capacity

Represents the actual resources of the underlying volume.

false

object

- -
-
-

v1.UniqueVolumeName

- -
-
-

unversioned.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

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

false

unversioned.LabelSelectorRequirement array

- -
-
-

v1.EndpointSubset

-
-

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- }
-The resulting set of endpoints can be viewed as:
- a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
- b: [ 10.10.1.1:309, 10.10.2.2:309 ]

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

addresses

IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

false

v1.EndpointAddress array

notReadyAddresses

IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

false

v1.EndpointAddress array

ports

Port numbers available on the related IP addresses.

false

v1.EndpointPort array

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

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

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

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

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

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

false

v1.SecretKeySelector

- -
-
-

v1.Scale

-
-

Scale represents a scaling request for a resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.ScaleSpec

status

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

false

v1.ScaleStatus

- -
-
-

v1.LoadBalancerIngress

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

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

false

string

hostname

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

false

string

- -
-
-

v1.AzureDiskVolumeSource

-
-

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

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

false

boolean

false

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.Service

-
-

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.ServiceSpec

status

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

false

v1.ServiceStatus

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.ServiceAccountList

-
-

ServiceAccountList is a list of ServiceAccount objects

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.ServiceAccount array

- -
-
-

v1.LimitRangeList

-
-

LimitRangeList is a list of LimitRange items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1.LimitRange array

- -
-
-

v1.Endpoints

-
-

Endpoints is a collection of endpoints that implement the actual service. Example:
- Name: "mysvc",
- Subsets: [
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- },
- {
- Addresses: [{"ip": "10.10.3.3"}],
- Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
- },
- ]

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

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

false

v1.ObjectMeta

subsets

The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

true

v1.EndpointSubset array

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

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

false

v1.Preconditions

orphanDependents

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

false

boolean

false

- -
-
-

v1.Volume

-
-

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

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

emptyDir

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

false

v1.EmptyDirVolumeSource

gcePersistentDisk

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

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

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

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

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

false

v1.SecretVolumeSource

nfs

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

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.4/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

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

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

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

false

v1.PersistentVolumeClaimVolumeSource

rbd

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

false

v1.RBDVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

cinder

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

false

v1.CinderVolumeSource

cephfs

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

false

v1.CephFSVolumeSource

flocker

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

false

v1.FlockerVolumeSource

downwardAPI

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

false

v1.DownwardAPIVolumeSource

fc

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

false

v1.FCVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

- -
-
-

v1.ResourceFieldSelector

-
-

ResourceFieldSelector represents container resources (cpu, memory) and their output format

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

- -
-
-

v1.Probe

-
-

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

- -
-
-

unversioned.APIResourceList

-
-

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

key

The key of the secret to select from. Must be a valid secret key.

true

string

- -
-
-

v1.ReplicationController

-
-

ReplicationController represents the configuration of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ReplicationControllerSpec

status

Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ReplicationControllerStatus

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

APIResource specifies the name of a resource and whether it is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

true

string

- -
-
-

v1.PodStatus

-
-

PodStatus represents information about the status of a pod. Status may trail the actual state of a system.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Current condition of the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-phase

false

string

conditions

Current service state of pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-conditions

false

v1.PodCondition array

message

A human readable message indicating details about why the pod is in this condition.

false

string

reason

A brief CamelCase message indicating details about why the pod is in this state. e.g. OutOfDisk

false

string

hostIP

IP address of the host to which the pod is assigned. Empty if not yet scheduled.

false

string

podIP

IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.

false

string

startTime

RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

false

string (date-time)

containerStatuses

The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-statuses

false

v1.ContainerStatus array

- -
-
-

v1.LimitRange

-
-

LimitRange sets resource usage limits for each kind of resource in a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the limits enforced. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.LimitRangeSpec

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

true

string

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/node-selection/README.md

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.4/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.ResourceQuota

-
-

ResourceQuota sets aggregate quota restrictions enforced per namespace

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the desired quota. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaSpec

status

Status defines the actual enforced quota and its current usage. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaStatus

- -
-
-

v1.EventList

-
-

EventList is a list of events.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of events

true

v1.Event array

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

- -
-
-

v1.ReplicationControllerSpec

-
-

ReplicationControllerSpec is the specification of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

false

integer (int32)

selector

Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

object

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#pod-template

false

v1.PodTemplateSpec

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

- -
-
-

v1.NodeStatus

-
-

NodeStatus is information about the current status of a node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capacity

Capacity represents the total resources of a node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#capacity for more details.

false

object

allocatable

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

false

object

phase

NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-phase The field is never populated, and now is deprecated.

false

string

conditions

Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-condition

false

v1.NodeCondition array

addresses

List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-addresses

false

v1.NodeAddress array

daemonEndpoints

Endpoints of daemons running on the Node.

false

v1.NodeDaemonEndpoints

nodeInfo

Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-info

false

v1.NodeSystemInfo

images

List of container images on this node

false

v1.ContainerImage array

volumesInUse

List of attachable volumes in use (mounted) by the node.

false

v1.UniqueVolumeName array

volumesAttached

List of volumes that are attached to the node.

false

v1.AttachedVolume array

- -
-
-

v1.GlusterfsVolumeSource

-
-

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

- -
-
-

v1.AttachedVolume

-
-

AttachedVolume describes a volume attached to a node

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the attached volume

true

string

devicePath

DevicePath represents the device path where the volume should be avilable

true

string

- -
-
-

v1.EventSource

-
-

EventSource contains information for an event.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

component

Component from which the event is generated.

false

string

host

Host name on which the event is generated.

false

string

- -
-
-

v1.PodCondition

-
-

PodCondition contains details for the current condition of this pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type is the type of the condition. Currently only Ready. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-conditions

true

string

status

Status is the status of the condition. Can be True, False, Unknown. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-conditions

true

string

lastProbeTime

Last time we probed the condition.

false

string (date-time)

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string (date-time)

reason

Unique, one-word, CamelCase reason for the condition’s last transition.

false

string

message

Human-readable message indicating details about last transition.

false

string

- -
-
-

v1.RBDVolumeSource

-
-

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1.PodTemplate

-
-

PodTemplate describes a template for creating copies of a predefined pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

template

Template defines the pods that will be created from this pod template. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodTemplateSpec

- -
-
-

v1.ServiceStatus

-
-

ServiceStatus represents the current status of a service.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

loadBalancer

LoadBalancer contains the current status of the load-balancer, if one is present.

false

v1.LoadBalancerStatus

- -
-
-

v1.NFSVolumeSource

-
-

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

true

string

path

Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

false

boolean

false

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.EndpointPort

-
-

EndpointPort is a tuple that describes a single port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.

false

string

port

The port number of the endpoint.

true

integer (int32)

protocol

The IP protocol for this port. Must be UDP or TCP. Default is TCP.

false

string

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

- -
-
-

v1.LoadBalancerStatus

-
-

LoadBalancerStatus represents the status of a load-balancer.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ingress

Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

false

v1.LoadBalancerIngress array

- -
-
-

v1.SecretList

-
-

SecretList is a list of Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

Items is a list of secret objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/secrets.md

true

v1.Secret array

- -
-
-

v1.Container

-
-

A single application container that you want to run within a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

image

Docker image name. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

List of environment variables to set in the container. Cannot be updated.

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/release-1.4/docs/design/security_context.md

false

v1.SecurityContext

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

false

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1.PersistentVolumeSpec

-
-

PersistentVolumeSpec is the specification of a persistent volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capacity

A description of the persistent volume’s resources and capacity. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#capacity

false

object

gcePersistentDisk

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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

hostPath

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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

glusterfs

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

nfs

NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

false

v1.NFSVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

iscsi

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.

false

v1.ISCSIVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

flocker

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

false

v1.FlockerVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

accessModes

AccessModes contains all ways the volume can be mounted. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#access-modes

false

v1.PersistentVolumeAccessMode array

claimRef

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: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#binding

false

v1.ObjectReference

persistentVolumeReclaimPolicy

What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#recycling-policy

false

string

- -
-
-

v1.ReplicationControllerStatus

-
-

ReplicationControllerStatus represents the current status of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

The number of pods that have labels matching the labels of the pod template of the replication controller.

false

integer (int32)

readyReplicas

The number of ready replicas for this replication controller.

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed replication controller.

false

integer (int64)

- -
-
-

v1.FinalizerName

- -
-
-

v1.ServicePort

-
-

ServicePort contains information on service’s port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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.

false

string

protocol

The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.

false

string

port

The port that will be exposed by this service.

true

integer (int32)

targetPort

Number 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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#defining-a-service

false

string

nodePort

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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#type—nodeport

false

integer (int32)

- -
-
-

v1.ComponentCondition

-
-

Information about the condition of a component.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of condition for a component. Valid value: "Healthy"

true

string

status

Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

true

string

message

Message about the condition for a component. For example, information about a health check.

false

string

error

Condition error code for a component. For example, a health check error code.

false

string

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

true

string

uid

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

v1.ScaleSpec

-
-

ScaleSpec describes the attributes of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

- -
-
-

v1.ComponentStatusList

-
-

Status of all the conditions for the component as a list of ComponentStatus objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of ComponentStatus objects.

true

v1.ComponentStatus array

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

true

string

- -
-
-

v1.ContainerStateTerminated

-
-

ContainerStateTerminated is a terminated state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exitCode

Exit status from the last termination of the container

true

integer (int32)

signal

Signal from the last termination of the container

false

integer (int32)

reason

(brief) reason from the last termination of the container

false

string

message

Message regarding the last termination of the container

false

string

startedAt

Time at which previous execution of the container started

false

string (date-time)

finishedAt

Time at which the container last terminated

false

string (date-time)

containerID

Container’s ID in the format docker://<container_id>

false

string

- -
-
-

v1.Binding

-
-

Binding ties one object to another. For example, a pod is bound to a node by a scheduler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

target

The target object that you want to bind to the standard object.

true

v1.ObjectReference

- -
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.ContainerState

-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

waiting

Details about a waiting container

false

v1.ContainerStateWaiting

running

Details about a running container

false

v1.ContainerStateRunning

terminated

Details about a terminated container

false

v1.ContainerStateTerminated

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1alpha1.Eviction

-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

ObjectMeta describes the pod that is being evicted.

false

v1.ObjectMeta

deleteOptions

DeleteOptions may be provided

false

v1.DeleteOptions

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

- -
-
-

v1.ContainerStatus

-
-

ContainerStatus contains details for the current status of this container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

true

string

state

Details about the container’s current condition.

false

v1.ContainerState

lastState

Details about the container’s last termination condition.

false

v1.ContainerState

ready

Specifies whether the container has passed its readiness probe.

true

boolean

false

restartCount

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.

true

integer (int32)

image

The image the container is running. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

true

string

imageID

ImageID of the container’s image.

true

string

containerID

Container’s ID in the format docker://<container_id>. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#container-information

false

string

- -
-
-

v1.QuobyteVolumeSource

-
-

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

- -
-
-

v1.ContainerImage

-
-

Describe a container image

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

names

Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]

true

string array

sizeBytes

The size of the image in bytes.

false

integer (int64)

- -
-
-

v1.ResourceQuotaScope

- -
-
-

v1.ReplicationControllerList

-
-

ReplicationControllerList is a collection of replication controllers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of replication controllers. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md

true

v1.ReplicationController array

- -
-
-

v1.NodeDaemonEndpoints

-
-

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kubeletEndpoint

Endpoint on which Kubelet is listening.

false

v1.DaemonEndpoint

- -
-
-

v1.Secret

-
-

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

data

Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. 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

false

object

stringData

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.

false

object

type

Used to facilitate programmatic handling of secret data.

false

string

- -
-
-

v1.Event

-
-

Event is a report of an event somewhere in the cluster.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

true

v1.ObjectMeta

involvedObject

The object that this event is about.

true

v1.ObjectReference

reason

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

false

string

message

A human-readable description of the status of this operation.

false

string

source

The component reporting this event. Should be a short machine understandable string.

false

v1.EventSource

firstTimestamp

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

false

string (date-time)

lastTimestamp

The time at which the most recent occurrence of this event was recorded.

false

string (date-time)

count

The number of times this event has occurred.

false

integer (int32)

type

Type of this event (Normal, Warning), new types could be added in the future

false

string

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.PersistentVolumeAccessMode

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

- -
-
-

v1.ComponentStatus

-
-

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

conditions

List of component conditions observed

false

v1.ComponentCondition array

- -
-
-

v1.LimitRangeItem

-
-

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of resource that this limit applies to.

false

string

max

Max usage constraints on this kind by resource name.

false

object

min

Min usage constraints on this kind by resource name.

false

object

default

Default resource requirement limit value by resource name if resource limit is omitted.

false

object

defaultRequest

DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

false

object

maxLimitRequestRatio

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.

false

object

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

- -
-
-

v1.PodList

-
-

PodList is a list of Pods.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of pods. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pods.md

true

v1.Pod array

- -
-
-

v1.ServiceList

-
-

ServiceList holds a list of services.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of services

true

v1.Service array

- -
-
-

v1.PersistentVolumeList

-
-

PersistentVolumeList is a list of PersistentVolume items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of persistent volumes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md

true

v1.PersistentVolume array

- -
-
-

v1.ObjectReference

-
-

ObjectReference contains enough information to let you inspect or modify the referred object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

namespace

Namespace of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

false

string

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

uid

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

false

string

apiVersion

API version of the referent.

false

string

resourceVersion

Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

fieldPath

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.

false

string

- -
-
-

unversioned.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

v1.ContainerStateWaiting

-
-

ContainerStateWaiting is a waiting state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

(brief) reason the container is not yet running.

false

string

message

Message regarding why the container is not yet running.

false

string

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

key

The key to select.

true

string

- -
-
-

v1.NodeSystemInfo

-
-

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

machineID

Machine ID reported by the node.

true

string

systemUUID

System UUID reported by the node.

true

string

bootID

Boot ID reported by the node.

true

string

kernelVersion

Kernel Version reported by the node from uname -r (e.g. 3.16.0-0.bpo.4-amd64).

true

string

osImage

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

true

string

containerRuntimeVersion

ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

true

string

kubeletVersion

Kubelet Version reported by the node.

true

string

kubeProxyVersion

KubeProxy Version reported by the node.

true

string

operatingSystem

The Operating System reported by the node

true

string

architecture

The Architecture reported by the node

true

string

- -
-
-

v1.ServiceSpec

-
-

ServiceSpec describes the attributes that a user creates on a service.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ports

The list of ports that are exposed by this service. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

true

v1.ServicePort array

selector

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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview

false

object

clusterIP

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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

type

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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview

false

string

externalIPs

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. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.

false

string array

deprecatedPublicIPs

deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.

false

string array

sessionAffinity

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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

loadBalancerIP

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.

false

string

loadBalancerSourceRanges

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: http://releases.k8s.io/release-1.4/docs/user-guide/services-firewalls.md

false

string array

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.

false

string

- -
-
-

v1.Pod

-
-

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

status

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodStatus

- -
-
-

v1.NodeSpec

-
-

NodeSpec describes the attributes that a node is created with.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podCIDR

PodCIDR represents the pod IP range assigned to the node.

false

string

externalID

External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.

false

string

providerID

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

false

string

unschedulable

Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#manual-node-administration"`

false

boolean

false

- -
-
-

v1.EndpointAddress

-
-

EndpointAddress is a tuple that describes single IP address.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

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.

true

string

hostname

The Hostname of this endpoint

false

string

nodeName

Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

false

string

targetRef

Reference to object providing the endpoint.

false

v1.ObjectReference

- -
-
-

v1.DaemonEndpoint

-
-

DaemonEndpoint contains information about a single Daemon endpoint.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

Port

Port number of the given endpoint.

true

integer (int32)

- -
-
-

v1.AzureDataDiskCachingMode

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.4/v1-operations.html b/_includes/v1.4/v1-operations.html deleted file mode 100755 index b5e4222cf1c27..0000000000000 --- a/_includes/v1.4/v1-operations.html +++ /dev/null @@ -1,32451 +0,0 @@ - - - - - - -Operations - - - -
-
-

Operations

-
-
-

get available resources

-
-
-
GET /api/v1
-
-
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

unversioned.APIResourceList

- -
-
-

Consumes

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list objects of kind ComponentStatus

-
-
-
GET /api/v1/componentstatuses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ComponentStatusList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ComponentStatus

-
-
-
GET /api/v1/componentstatuses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the ComponentStatus

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ComponentStatus

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ConfigMap

-
-
-
GET /api/v1/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMapList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Endpoints

-
-
-
GET /api/v1/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EndpointsList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Event

-
-
-
GET /api/v1/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EventList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind LimitRange

-
-
-
GET /api/v1/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRangeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Namespace

-
-
-
GET /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.NamespaceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Namespace

-
-
-
DELETE /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Namespace

-
-
-
POST /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Binding

-
-
-
POST /api/v1/namespaces/{namespace}/bindings
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Binding

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ConfigMap

-
-
-
GET /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMapList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ConfigMap

-
-
-
DELETE /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ConfigMap

-
-
-
POST /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ConfigMap

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ConfigMap

-
-
-
GET /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ConfigMap

-
-
-
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ConfigMap

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ConfigMap

-
-
-
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ConfigMap

-
-
-
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Endpoints

-
-
-
GET /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EndpointsList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Endpoints

-
-
-
DELETE /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create an Endpoints

-
-
-
POST /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Endpoints

-
-
-
GET /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Endpoints

-
-
-
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete an Endpoints

-
-
-
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Endpoints

-
-
-
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Event

-
-
-
GET /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EventList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Event

-
-
-
DELETE /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create an Event

-
-
-
POST /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Event

-
-
-
GET /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Event

-
-
-
PUT /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete an Event

-
-
-
DELETE /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Event

-
-
-
PATCH /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind LimitRange

-
-
-
GET /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRangeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of LimitRange

-
-
-
DELETE /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a LimitRange

-
-
-
POST /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified LimitRange

-
-
-
GET /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified LimitRange

-
-
-
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a LimitRange

-
-
-
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified LimitRange

-
-
-
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaimList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PersistentVolumeClaim

-
-
-
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PersistentVolumeClaim

-
-
-
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PersistentVolumeClaim

-
-
-
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PersistentVolumeClaim

-
-
-
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PersistentVolumeClaim

-
-
-
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified PersistentVolumeClaim

-
-
-
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified PersistentVolumeClaim

-
-
-
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Pod

-
-
-
PATCH /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to attach of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to attach of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create binding of a Binding

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Binding

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Binding

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create eviction of an Eviction

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1alpha1.Eviction

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Eviction

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1alpha1.Eviction

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to exec of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to exec of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read log of the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/log
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

container

The container for which to stream logs. Defaults to only container if there is one container in the pod.

false

string

QueryParameter

follow

Follow the log stream of the pod. Defaults to false.

false

boolean

QueryParameter

previous

Return previous terminated container logs. Defaults to false.

false

boolean

QueryParameter

sinceSeconds

A 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.

false

integer (int32)

QueryParameter

sinceTime

An RFC3339 timestamp 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.

false

string

QueryParameter

timestamps

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

false

boolean

QueryParameter

tailLines

If 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

false

integer (int32)

QueryParameter

limitBytes

If 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.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    text/plain

    -
    • -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to portforward of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to portforward of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Pod

-
-
-
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PodTemplate

-
-
-
GET /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PodTemplate

-
-
-
DELETE /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PodTemplate

-
-
-
POST /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PodTemplate

-
-
-
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PodTemplate

-
-
-
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PodTemplate

-
-
-
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PodTemplate

-
-
-
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ReplicationController

-
-
-
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ReplicationController

-
-
-
POST /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ReplicationController

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ReplicationController

-
-
-
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ReplicationController

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified ReplicationController

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified ReplicationController

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ResourceQuota

-
-
-
DELETE /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ResourceQuota

-
-
-
POST /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ResourceQuota

-
-
-
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ResourceQuota

-
-
-
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ResourceQuota

-
-
-
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified ResourceQuota

-
-
-
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified ResourceQuota

-
-
-
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Secret

-
-
-
GET /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.SecretList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Secret

-
-
-
DELETE /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Secret

-
-
-
POST /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Secret

-
-
-
GET /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Secret

-
-
-
PUT /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Secret

-
-
-
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Secret

-
-
-
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ServiceAccount

-
-
-
GET /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ServiceAccount

-
-
-
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ServiceAccount

-
-
-
POST /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ServiceAccount

-
-
-
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ServiceAccount

-
-
-
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ServiceAccount

-
-
-
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ServiceAccount

-
-
-
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Service

-
-
-
GET /api/v1/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Service

-
-
-
POST /api/v1/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Service

-
-
-
PATCH /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Service

-
-
-
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Service

-
-
-
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Service

-
-
-
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Namespace

-
-
-
GET /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Namespace

-
-
-
DELETE /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Namespace

-
-
-
PATCH /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace finalize of the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}/finalize
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Namespace

-
-
-
GET /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Namespace

-
-
-
PATCH /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Node

-
-
-
GET /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.NodeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Node

-
-
-
DELETE /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Node

-
-
-
POST /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Node

-
-
-
GET /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Node

-
-
-
PUT /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Node

-
-
-
DELETE /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Node

-
-
-
PATCH /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Node

-
-
-
GET /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Node

-
-
-
PUT /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Node

-
-
-
DELETE /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Node

-
-
-
POST /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Node

-
-
-
GET /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Node

-
-
-
PUT /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Node

-
-
-
DELETE /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Node

-
-
-
POST /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Node

-
-
-
GET /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Node

-
-
-
PUT /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Node

-
-
-
PATCH /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolumeClaim

-
-
-
GET /api/v1/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaimList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolume

-
-
-
GET /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PersistentVolume

-
-
-
DELETE /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PersistentVolume

-
-
-
POST /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PersistentVolume

-
-
-
GET /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PersistentVolume

-
-
-
PUT /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PersistentVolume

-
-
-
DELETE /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PersistentVolume

-
-
-
PATCH /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified PersistentVolume

-
-
-
GET /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified PersistentVolume

-
-
-
PUT /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified PersistentVolume

-
-
-
PATCH /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Pod

-
-
-
GET /api/v1/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PodTemplate

-
-
-
GET /api/v1/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Pod

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Pod

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Pod

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Pod

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Pod

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Pod

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Pod

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Pod

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Service

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Service

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Service

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Service

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Service

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Service

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Service

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Service

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Node

-
-
-
GET /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Node

-
-
-
PUT /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Node

-
-
-
DELETE /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Node

-
-
-
POST /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Node

-
-
-
GET /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Node

-
-
-
PUT /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Node

-
-
-
DELETE /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Node

-
-
-
POST /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicationController

-
-
-
GET /api/v1/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ResourceQuota

-
-
-
GET /api/v1/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Secret

-
-
-
GET /api/v1/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.SecretList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ServiceAccount

-
-
-
GET /api/v1/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Service

-
-
-
GET /api/v1/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ConfigMap

-
-
-
GET /api/v1/watch/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Endpoints

-
-
-
GET /api/v1/watch/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Event

-
-
-
GET /api/v1/watch/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of LimitRange

-
-
-
GET /api/v1/watch/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Namespace

-
-
-
GET /api/v1/watch/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ConfigMap

-
-
-
GET /api/v1/watch/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ConfigMap

-
-
-
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Endpoints

-
-
-
GET /api/v1/watch/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Endpoints

-
-
-
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Event

-
-
-
GET /api/v1/watch/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Event

-
-
-
GET /api/v1/watch/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of LimitRange

-
-
-
GET /api/v1/watch/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind LimitRange

-
-
-
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolumeClaim

-
-
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PersistentVolumeClaim

-
-
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Pod

-
-
-
GET /api/v1/watch/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Pod

-
-
-
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PodTemplate

-
-
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PodTemplate

-
-
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicationController

-
-
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ReplicationController

-
-
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ResourceQuota

-
-
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ResourceQuota

-
-
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Secret

-
-
-
GET /api/v1/watch/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Secret

-
-
-
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ServiceAccount

-
-
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ServiceAccount

-
-
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Service

-
-
-
GET /api/v1/watch/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Service

-
-
-
GET /api/v1/watch/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Namespace

-
-
-
GET /api/v1/watch/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Node

-
-
-
GET /api/v1/watch/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Node

-
-
-
GET /api/v1/watch/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolumeClaim

-
-
-
GET /api/v1/watch/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolume

-
-
-
GET /api/v1/watch/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PersistentVolume

-
-
-
GET /api/v1/watch/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Pod

-
-
-
GET /api/v1/watch/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PodTemplate

-
-
-
GET /api/v1/watch/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicationController

-
-
-
GET /api/v1/watch/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ResourceQuota

-
-
-
GET /api/v1/watch/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Secret

-
-
-
GET /api/v1/watch/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ServiceAccount

-
-
-
GET /api/v1/watch/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Service

-
-
-
GET /api/v1/watch/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

*versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.5/extensions-v1beta1-definitions.html b/_includes/v1.5/extensions-v1beta1-definitions.html deleted file mode 100755 index caa52743dd054..0000000000000 --- a/_includes/v1.5/extensions-v1beta1-definitions.html +++ /dev/null @@ -1,6471 +0,0 @@ - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1beta1.DeploymentStatus

-
-

DeploymentStatus is the most recently observed status of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

The generation observed by the deployment controller.

false

integer (int64)

replicas

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

false

integer (int32)

updatedReplicas

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

false

integer (int32)

availableReplicas

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

false

integer (int32)

unavailableReplicas

Total number of unavailable pods targeted by this deployment.

false

integer (int32)

conditions

Represents the latest available observations of a deployment’s current state.

false

v1beta1.DeploymentCondition array

- -
-
-

v1beta1.DaemonSetStatus

-
-

DaemonSetStatus represents the current status of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

currentNumberScheduled

CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md

true

integer (int32)

numberMisscheduled

NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md

true

integer (int32)

desiredNumberScheduled

DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md

true

integer (int32)

numberReady

NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

true

integer (int32)

- -
-
-

v1beta1.Job

-
-

Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobSpec

status

Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobStatus

- -
-
-

v1.Preconditions

-
-

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

Version of the schema the FieldPath is written in terms of, defaults to "v1".

false

string

fieldPath

Path of the field to select in the specified API version.

true

string

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

User is a SELinux user label that applies to the container.

false

string

role

Role is a SELinux role label that applies to the container.

false

string

type

Type is a SELinux type label that applies to the container.

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

false

boolean

false

mountPath

Path within the container at which the volume should be mounted. Must not contain :.

true

string

subPath

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

false

string

- -
-
-

v1beta1.IngressSpec

-
-

IngressSpec describes the Ingress the user wishes to exist.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

backend

A default backend capable of servicing requests that don’t match any rule. At least one of backend or rules must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.

false

v1beta1.IngressBackend

tls

TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

false

v1beta1.IngressTLS array

rules

A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

false

v1beta1.IngressRule array

- -
-
-

v1beta1.IngressBackend

-
-

IngressBackend describes all endpoints for a given service and port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

serviceName

Specifies the name of the referenced service.

true

string

servicePort

Specifies the port of the referenced service.

true

string

- -
-
-

v1beta1.ReplicaSetList

-
-

ReplicaSetList is a collection of ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of ReplicaSets. More info: http://kubernetes.io/docs/user-guide/replication-controller

true

v1beta1.ReplicaSet array

- -
-
-

v1.CephFSVolumeSource

-
-

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

true

string array

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

string

user

Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretFile

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1beta1.IngressStatus

-
-

IngressStatus describe the current state of the Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

loadBalancer

LoadBalancer contains the current status of the load-balancer.

false

v1.LoadBalancerStatus

- -
-
-

v1.DownwardAPIVolumeSource

-
-

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusCause

-
-

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

A machine-readable description of the cause of the error. If this value is empty there is no information available.

false

string

message

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

false

string

field

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"

false

string

- -
-
-

v1beta1.ReplicaSetCondition

-
-

ReplicaSetCondition describes the state of a replica set at a certain point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of replica set condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastTransitionTime

The last time the condition transitioned from one status to another.

false

string (date-time)

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

- -
-
-

v1beta1.NetworkPolicyList

-
-

Network Policy List is a list of NetworkPolicy objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is a list of schema objects.

true

v1beta1.NetworkPolicy array

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

integer (int32)

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

boolean

false

- -
-
-

v1beta1.RollingUpdateDeployment

-
-

Spec to control the desired behavior of rolling update.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

maxUnavailable

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

false

string

maxSurge

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.

false

string

- -
-
-

v1beta1.HTTPIngressRuleValue

-
-

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

paths

A collection of paths that map requests to backends.

true

v1beta1.HTTPIngressPath array

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

v1beta1.JobStatus

-
-

JobStatus represents the current state of a Job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

conditions

Conditions represent the latest available observations of an object’s current state. More info: http://kubernetes.io/docs/user-guide/jobs

false

v1beta1.JobCondition array

startTime

StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

completionTime

CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

active

Active is the number of actively running pods.

false

integer (int32)

succeeded

Succeeded is the number of pods which reached Phase Succeeded.

false

integer (int32)

failed

Failed is the number of pods which reached Phase Failed.

false

integer (int32)

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.LocalObjectReference

-
-

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.ObjectMeta

-
-

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

false

string

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

- -
-
-

v1beta1.ReplicaSetSpec

-
-

ReplicaSetSpec is the specification of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

false

integer (int32)

minReadySeconds

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

false

integer (int32)

selector

Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

false

v1.PodTemplateSpec

- -
-
-

v1beta1.DaemonSetSpec

-
-

DaemonSetSpec is the specification of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selector

Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

template

Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

true

v1.PodTemplateSpec

- -
-
-

v1beta1.Deployment

-
-

Deployment enables declarative updates for Pods and ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata.

false

v1.ObjectMeta

spec

Specification of the desired behavior of the Deployment.

false

v1beta1.DeploymentSpec

status

Most recently observed status of the Deployment.

false

v1beta1.DeploymentStatus

- -
-
-

v1.AzureFileVolumeSource

-
-

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

the name of secret that contains Azure Storage Account Name and Key

true

string

shareName

Share Name

true

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

types.UID

- -
-
-

v1.ISCSIVolumeSource

-
-

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi

false

string

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

string

- -
-
-

v1beta1.IngressList

-
-

IngressList is a collection of Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is the list of Ingress.

true

v1beta1.Ingress array

- -
-
-

v1beta1.ScaleSpec

-
-

describes the attributes of a scale subresource

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

- -
-
-

unversioned.Patch

-
-

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

-
-
-
-

v1.FlockerVolumeSource

-
-

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

string

datasetUUID

UUID of the dataset. This is unique identifier of a Flocker dataset

false

string

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1beta1.HorizontalPodAutoscaler

-
-

configuration of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.

false

v1beta1.HorizontalPodAutoscalerSpec

status

current information about the autoscaler.

false

v1beta1.HorizontalPodAutoscalerStatus

- -
-
-

unversioned.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

unversioned.LabelSelectorRequirement array

- -
-
-

v1beta1.RollbackConfig

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

revision

The revision to rollback to. If set to 0, rollbck to the last revision.

false

integer (int64)

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

Selects a key of a secret in the pod’s namespace

false

v1.SecretKeySelector

- -
-
-

v1.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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

Driver is the name of the driver to use for this volume.

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1beta1.JobCondition

-
-

JobCondition describes current state of a job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of job condition, Complete or Failed.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastProbeTime

Last time the condition was checked.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.LoadBalancerIngress

-
-

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

false

string

hostname

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

false

string

- -
-
-

v1beta1.APIVersion

-
-

An APIVersion represents a single concrete version of an object model.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of this version (e.g. v1).

false

string

- -
-
-

v1.AzureDiskVolumeSource

-
-

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

false

- -
-
-

v1.Volume

-
-

Volume represents a named volume in a pod that may be accessed by any container in the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

false

v1.HostPathVolumeSource

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

v1.SecretVolumeSource

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

photonPersistentDisk

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

false

v1.PhotonPersistentDiskVolumeSource

- -
-
-

v1beta1.DaemonSetList

-
-

DaemonSetList is a collection of daemon sets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is a list of daemon sets.

true

v1beta1.DaemonSet array

- -
-
-

v1.ResourceFieldSelector

-
-

ResourceFieldSelector represents container resources (cpu, memory) and their output format

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

- -
-
-

v1.Probe

-
-

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

- -
-
-

v1beta1.DeploymentSpec

-
-

DeploymentSpec is the specification of the desired behavior of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

false

integer (int32)

selector

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

false

unversioned.LabelSelector

template

Template describes the pods that will be created.

true

v1.PodTemplateSpec

strategy

The deployment strategy to use to replace existing pods with new ones.

false

v1beta1.DeploymentStrategy

minReadySeconds

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

false

integer (int32)

revisionHistoryLimit

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.

false

integer (int32)

paused

Indicates that the deployment is paused and will not be processed by the deployment controller.

false

boolean

false

rollbackTo

The config this deployment is rolling back to. Will be cleared after rollback is done.

false

v1beta1.RollbackConfig

progressDeadlineSeconds

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.

false

integer (int32)

- -
-
-

unversioned.APIResourceList

-
-

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key of the secret to select from. Must be a valid secret key.

true

string

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

APIResource specifies the name of a resource and whether it is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

true

string

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

true

string

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

- -
-
-

v1.GlusterfsVolumeSource

-
-

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

- -
-
-

v1beta1.IngressTLS

-
-

IngressTLS describes the transport layer security associated with an Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hosts

Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.

false

string array

secretName

SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

false

string

- -
-
-

v1beta1.SubresourceReference

-
-

SubresourceReference contains enough information to let you inspect or modify the referred subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

name

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

apiVersion

API version of the referent

false

string

subresource

Subresource name of the referent

false

string

- -
-
-

v1beta1.Scale

-
-

represents a scaling request for a resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.

false

v1.ObjectMeta

spec

defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.

false

v1beta1.ScaleSpec

status

current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.

false

v1beta1.ScaleStatus

- -
-
-

v1.RBDVolumeSource

-
-

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#rbd

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1.PhotonPersistentDiskVolumeSource

-
-

Represents a Photon Controller persistent disk resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdID

ID that identifies Photon Controller persistent disk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1beta1.NetworkPolicy

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior for this NetworkPolicy.

false

v1beta1.NetworkPolicySpec

- -
-
-

versioned.Event

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

true

string

object

true

string

- -
-
-

v1beta1.ScaleStatus

-
-

represents the current status of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

object

targetSelector

label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

string

- -
-
-

v1beta1.NetworkPolicySpec

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.

true

unversioned.LabelSelector

ingress

List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list.

false

v1beta1.NetworkPolicyIngressRule array

- -
-
-

v1.NFSVolumeSource

-
-

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

path

Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

boolean

false

- -
-
-

v1beta1.DeploymentList

-
-

DeploymentList is a list of Deployments.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of Deployments.

true

v1beta1.Deployment array

- -
-
-

v1beta1.DeploymentRollback

-
-

DeploymentRollback stores the information required to rollback a deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

name

Required: This must match the Name of a deployment.

true

string

updatedAnnotations

The annotations to be updated to a deployment

false

object

rollbackTo

The config of this deployment rollback.

true

v1beta1.RollbackConfig

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1beta1.HorizontalPodAutoscalerStatus

-
-

current status of a horizontal pod autoscaler

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

most recent generation observed by this autoscaler.

false

integer (int64)

lastScaleTime

last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.

false

string (date-time)

currentReplicas

current number of replicas of pods managed by this autoscaler.

true

integer (int32)

desiredReplicas

desired number of replicas of pods managed by this autoscaler.

true

integer (int32)

currentCPUUtilizationPercentage

current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.

false

integer (int32)

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1beta1.ThirdPartyResource

-
-

A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata

false

v1.ObjectMeta

description

Description is the description of this object.

false

string

versions

Versions are versions for this third party object

false

v1beta1.APIVersion array

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

v1beta1.DeploymentStrategy

-
-

DeploymentStrategy describes how to replace existing pods with new ones.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

false

string

rollingUpdate

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

false

v1beta1.RollingUpdateDeployment

- -
-
-

v1beta1.IngressRule

-
-

IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

host

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
- 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.

false

string

http

false

v1beta1.HTTPIngressRuleValue

- -
-
-

v1beta1.JobList

-
-

JobList is a collection of jobs. DEPRECATED: extensions/v1beta1.JobList is deprecated, use batch/v1.JobList instead.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is the list of Job.

true

v1beta1.Job array

- -
-
-

v1beta1.NetworkPolicyPeer

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.

false

unversioned.LabelSelector

namespaceSelector

Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.

false

unversioned.LabelSelector

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

- -
-
-

v1.LoadBalancerStatus

-
-

LoadBalancerStatus represents the status of a load-balancer.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ingress

Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

false

v1.LoadBalancerIngress array

- -
-
-

v1beta1.CPUTargetUtilization

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPercentage

fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use.

true

integer (int32)

- -
-
-

v1.Container

-
-

A single application container that you want to run within a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

image

Docker image name. More info: http://kubernetes.io/docs/user-guide/images

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

List of environment variables to set in the container. Cannot be updated.

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md

false

v1.SecurityContext

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

false

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1beta1.NetworkPolicyIngressRule

-
-

This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ports

List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.

false

v1beta1.NetworkPolicyPort array

from

List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.

false

v1beta1.NetworkPolicyPeer array

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

v1beta1.ReplicaSetStatus

-
-

ReplicaSetStatus represents the current status of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

The number of pods that have labels matching the labels of the pod template of the replicaset.

false

integer (int32)

readyReplicas

The number of ready replicas for this replica set.

false

integer (int32)

availableReplicas

The number of available replicas (ready for at least minReadySeconds) for this replica set.

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

false

integer (int64)

conditions

Represents the latest available observations of a replica set’s current state.

false

v1beta1.ReplicaSetCondition array

- -
-
-

v1beta1.ReplicaSet

-
-

ReplicaSet represents the configuration of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the specification of the desired behavior of the ReplicaSet. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.ReplicaSetSpec

status

Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.ReplicaSetStatus

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

true

string

- -
-
-

v1beta1.DaemonSet

-
-

DaemonSet represents the configuration of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.DaemonSetSpec

status

Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.DaemonSetStatus

- -
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.Protocol

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

boolean

false

- -
-
-

v1beta1.HorizontalPodAutoscalerSpec

-
-

specification of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

scaleRef

reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec.

true

v1beta1.SubresourceReference

minReplicas

lower limit for the number of pods that can be set by the autoscaler, default 1.

false

integer (int32)

maxReplicas

upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

true

integer (int32)

cpuUtilization

target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources.

false

v1beta1.CPUTargetUtilization

- -
-
-

v1.QuobyteVolumeSource

-
-

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

- -
-
-

v1beta1.NetworkPolicyPort

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

protocol

Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

false

v1.Protocol

port

If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.

false

string

- -
-
-

v1beta1.DeploymentCondition

-
-

DeploymentCondition describes the state of a deployment at a certain point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of deployment condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastUpdateTime

The last time this condition was updated.

false

string (date-time)

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string (date-time)

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

- -
-
-

v1beta1.JobSpec

-
-

JobSpec describes how the job execution will look like.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

parallelism

Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs

false

integer (int32)

completions

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs

false

integer (int32)

activeDeadlineSeconds

Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

false

integer (int64)

selector

Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

autoSelector

AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md

false

boolean

false

template

Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs

true

v1.PodTemplateSpec

- -
-
-

unversioned.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

- -
-
-

v1beta1.HorizontalPodAutoscalerList

-
-

list of horizontal pod autoscaler objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

list of horizontal pod autoscaler objects.

true

v1beta1.HorizontalPodAutoscaler array

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key to select.

true

string

- -
-
-

v1beta1.HTTPIngressPath

-
-

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e. this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend.

false

string

backend

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

true

v1beta1.IngressBackend

- -
-
-

v1beta1.Ingress

-
-

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec is the desired state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.IngressSpec

status

Status is the current state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.IngressStatus

- -
-
-

v1beta1.ThirdPartyResourceList

-
-

ThirdPartyResourceList is a list of ThirdPartyResources.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of ThirdPartyResources.

true

v1beta1.ThirdPartyResource array

- -
-
-

v1.AzureDataDiskCachingMode

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.5/extensions-v1beta1-operations.html b/_includes/v1.5/extensions-v1beta1-operations.html deleted file mode 100755 index 8ad9d2a2aad90..0000000000000 --- a/_includes/v1.5/extensions-v1beta1-operations.html +++ /dev/null @@ -1,15948 +0,0 @@ - - - - - - -Operations - - - -
-
-

Operations

-
-
-

get available resources

-
-
-
GET /apis/extensions/v1beta1
-
-
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

unversioned.APIResourceList

- -
-
-

Consumes

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscalerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.IngressList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Job

-
-
-
GET /apis/extensions/v1beta1/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.JobList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of DaemonSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a DaemonSet

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified DaemonSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a DaemonSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified DaemonSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified DaemonSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified DaemonSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DaemonSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified DaemonSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DaemonSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Deployment

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a Deployment

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Deployment

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a Deployment

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Deployment

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create rollback of a DeploymentRollback

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.DeploymentRollback

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DeploymentRollback

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.DeploymentRollback

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Deployment

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Deployment

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Deployment

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Deployment

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Deployment

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscalerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of HorizontalPodAutoscaler

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a HorizontalPodAutoscaler

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified HorizontalPodAutoscaler

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a HorizontalPodAutoscaler

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified HorizontalPodAutoscaler

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified HorizontalPodAutoscaler

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.HorizontalPodAutoscaler

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified HorizontalPodAutoscaler

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.HorizontalPodAutoscaler

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.IngressList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Ingress

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create an Ingress

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Ingress

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete an Ingress

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Ingress

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Ingress

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Ingress

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Ingress

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Ingress

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Ingress

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.JobList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of Job

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a Job

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified Job

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a Job

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified Job

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified Job

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified Job

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Job

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified Job

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Job

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicyList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of NetworkPolicy

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a NetworkPolicy

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.NetworkPolicy

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified NetworkPolicy

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.NetworkPolicy

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a NetworkPolicy

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified NetworkPolicy

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicy

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of ReplicaSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a ReplicaSet

-
-
-
POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified ReplicaSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a ReplicaSet

-
-
-
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified ReplicaSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read status of the specified ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace status of the specified ReplicaSet

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ReplicaSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update status of the specified ReplicaSet

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSet

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.NetworkPolicyList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ReplicaSetList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

list or watch objects of kind ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResourceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete collection of ThirdPartyResource

-
-
-
DELETE /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

create a ThirdPartyResource

-
-
-
POST /apis/extensions/v1beta1/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ThirdPartyResource

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

read the specified ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

replace the specified ThirdPartyResource

-
-
-
PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.ThirdPartyResource

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

delete a ThirdPartyResource

-
-
-
DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

partially update the specified ThirdPartyResource

-
-
-
PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.ThirdPartyResource

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Job

-
-
-
GET /apis/extensions/v1beta1/watch/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind DaemonSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the DaemonSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Deployment

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Deployment

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind HorizontalPodAutoscaler

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the HorizontalPodAutoscaler

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Ingress

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Ingress

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Job

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Job

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Job

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the NetworkPolicy

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicaSet

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of NetworkPolicy

-
-
-
GET /apis/extensions/v1beta1/watch/networkpolicies
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicaSet

-
-
-
GET /apis/extensions/v1beta1/watch/replicasets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/watch/thirdpartyresources
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ThirdPartyResource

-
-
-
GET /apis/extensions/v1beta1/watch/thirdpartyresources/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the ThirdPartyResource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apisextensionsv1beta1

    -
    • -
-
-
-
-
-
-
- - - \ No newline at end of file diff --git a/_includes/v1.5/v1-definitions.html b/_includes/v1.5/v1-definitions.html deleted file mode 100755 index 5dbb6c7094502..0000000000000 --- a/_includes/v1.5/v1-definitions.html +++ /dev/null @@ -1,8266 +0,0 @@ - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1.Node

-
-

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the behavior of a node. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.NodeSpec

status

Most recently observed status of the node. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.NodeStatus

- -
-
-

v1.PersistentVolumeClaimList

-
-

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

A list of persistent volume claims. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

true

v1.PersistentVolumeClaim array

- -
-
-

v1.Preconditions

-
-

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

User is a SELinux user label that applies to the container.

false

string

role

Role is a SELinux role label that applies to the container.

false

string

type

Type is a SELinux type label that applies to the container.

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

Version of the schema the FieldPath is written in terms of, defaults to "v1".

false

string

fieldPath

Path of the field to select in the specified API version.

true

string

- -
-
-

v1.ContainerStateRunning

-
-

ContainerStateRunning is a running state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

startedAt

Time at which the container was last (re-)started

false

string (date-time)

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

false

boolean

false

mountPath

Path within the container at which the volume should be mounted. Must not contain :.

true

string

subPath

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

false

string

- -
-
-

v1.PersistentVolumeClaimSpec

-
-

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

accessModes

AccessModes contains the desired access modes the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1

false

v1.PersistentVolumeAccessMode array

selector

A label query over volumes to consider for binding.

false

unversioned.LabelSelector

resources

Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources

false

v1.ResourceRequirements

volumeName

VolumeName is the binding reference to the PersistentVolume backing this claim.

false

string

- -
-
-

v1.CephFSVolumeSource

-
-

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

true

string array

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

string

user

Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretFile

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1.DownwardAPIVolumeSource

-
-

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusCause

-
-

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

A machine-readable description of the cause of the error. If this value is empty there is no information available.

false

string

message

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

false

string

field

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"

false

string

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

integer (int32)

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

boolean

false

- -
-
-

v1.ResourceQuotaSpec

-
-

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hard

Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

object

scopes

A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

false

v1.ResourceQuotaScope array

- -
-
-

v1.NamespaceStatus

-
-

NamespaceStatus is information about the current status of a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases

false

string

- -
-
-

v1.NamespaceSpec

-
-

NamespaceSpec describes the attributes on a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

finalizers

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers

false

v1.FinalizerName array

- -
-
-

v1.PersistentVolume

-
-

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes

false

v1.PersistentVolumeSpec

status

Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes

false

v1.PersistentVolumeStatus

- -
-
-

v1.ConfigMapList

-
-

ConfigMapList is a resource containing a list of ConfigMap objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is the list of ConfigMaps.

true

v1.ConfigMap array

- -
-
-

v1.PersistentVolumeStatus

-
-

PersistentVolumeStatus is the current status of a persistent volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#phase

false

string

message

A human-readable message indicating details about why the volume is in this state.

false

string

reason

Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

false

string

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.EndpointsList

-
-

EndpointsList is a list of endpoints.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of endpoints.

true

v1.Endpoints array

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

v1.ReplicationControllerCondition

-
-

ReplicationControllerCondition describes the state of a replication controller at a certain point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of replication controller condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastTransitionTime

The last time the condition transitioned from one status to another.

false

string (date-time)

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

- -
-
-

v1.ScaleStatus

-
-

ScaleStatus represents the current status of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

string

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.ConfigMap

-
-

ConfigMap holds configuration data for pods to consume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

data

Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.

false

object

- -
-
-

v1.PodTemplateList

-
-

PodTemplateList is a list of PodTemplates.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of pod templates

true

v1.PodTemplate array

- -
-
-

v1.NodeCondition

-
-

NodeCondition contains condition information for a node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of node condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastHeartbeatTime

Last time we got an update on a given condition.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.LocalObjectReference

-
-

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

- -
-
-

v1.ResourceQuotaStatus

-
-

ResourceQuotaStatus defines the enforced hard limits and observed use.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hard

Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

false

object

used

Used is the current observed total usage of the resource in the namespace.

false

object

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.ObjectMeta

-
-

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

false

string

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

- -
-
-

v1.LimitRangeSpec

-
-

LimitRangeSpec defines a min/max usage limit for resources that match on kind.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits is the list of LimitRangeItem objects that are enforced.

true

v1.LimitRangeItem array

- -
-
-

types.UID

- -
-
-

v1.AzureFileVolumeSource

-
-

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

the name of secret that contains Azure Storage Account Name and Key

true

string

shareName

Share Name

true

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.ISCSIVolumeSource

-
-

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi

false

string

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

string

- -
-
-

v1.NodeList

-
-

NodeList is the whole list of all Nodes which have been registered with master.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of nodes

true

v1.Node array

- -
-
-

unversioned.Patch

-
-

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

-
-
-
-

v1.NamespaceList

-
-

NamespaceList is a list of Namespaces.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

Items is the list of Namespace objects in the list. More info: http://kubernetes.io/docs/user-guide/namespaces

true

v1.Namespace array

- -
-
-

v1.PersistentVolumeClaim

-
-

PersistentVolumeClaim is a user’s request for and claim to a persistent volume

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the desired characteristics of a volume requested by a pod author. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

false

v1.PersistentVolumeClaimSpec

status

Status represents the current information/status of a persistent volume claim. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

false

v1.PersistentVolumeClaimStatus

- -
-
-

v1beta1.Eviction

-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

ObjectMeta describes the pod that is being evicted.

false

v1.ObjectMeta

deleteOptions

DeleteOptions may be provided

false

v1.DeleteOptions

- -
-
-

v1.ServiceAccount

-
-

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

secrets

Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: http://kubernetes.io/docs/user-guide/secrets

false

v1.ObjectReference array

imagePullSecrets

ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://kubernetes.io/docs/user-guide/secrets#manually-specifying-an-imagepullsecret

false

v1.LocalObjectReference array

- -
-
-

v1.NodeAddress

-
-

NodeAddress contains information for the node’s address.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Node address type, one of Hostname, ExternalIP or InternalIP.

true

string

address

The node address.

true

string

- -
-
-

v1.Namespace

-
-

Namespace provides a scope for Names. Use of multiple namespaces is optional.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.NamespaceSpec

status

Status describes the current status of a Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.NamespaceStatus

- -
-
-

v1.FlockerVolumeSource

-
-

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

string

datasetUUID

UUID of the dataset. This is unique identifier of a Flocker dataset

false

string

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1.ResourceQuotaList

-
-

ResourceQuotaList is a list of ResourceQuota items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

Items is a list of ResourceQuota objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

true

v1.ResourceQuota array

- -
-
-

v1.PersistentVolumeClaimStatus

-
-

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Phase represents the current phase of PersistentVolumeClaim.

false

string

accessModes

AccessModes contains the actual access modes the volume backing the PVC has. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1

false

v1.PersistentVolumeAccessMode array

capacity

Represents the actual resources of the underlying volume.

false

object

- -
-
-

v1.UniqueVolumeName

- -
-
-

unversioned.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

unversioned.LabelSelectorRequirement array

- -
-
-

v1.EndpointSubset

-
-

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- }
-The resulting set of endpoints can be viewed as:
- a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
- b: [ 10.10.1.1:309, 10.10.2.2:309 ]

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

addresses

IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

false

v1.EndpointAddress array

notReadyAddresses

IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

false

v1.EndpointAddress array

ports

Port numbers available on the related IP addresses.

false

v1.EndpointPort array

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

Driver is the name of the driver to use for this volume.

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

Selects a key of a secret in the pod’s namespace

false

v1.SecretKeySelector

- -
-
-

v1.Scale

-
-

Scale represents a scaling request for a resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.

false

v1.ObjectMeta

spec

defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.

false

v1.ScaleSpec

status

current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.

false

v1.ScaleStatus

- -
-
-

v1.LoadBalancerIngress

-
-

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

false

string

hostname

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

false

string

- -
-
-

v1.AzureDiskVolumeSource

-
-

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.Service

-
-

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the behavior of a service. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.ServiceSpec

status

Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.ServiceStatus

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.ServiceAccountList

-
-

ServiceAccountList is a list of ServiceAccount objects

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of ServiceAccounts. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts

true

v1.ServiceAccount array

- -
-
-

v1.LimitRangeList

-
-

LimitRangeList is a list of LimitRange items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

Items is a list of LimitRange objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md

true

v1.LimitRange array

- -
-
-

v1.Endpoints

-
-

Endpoints is a collection of endpoints that implement the actual service. Example:
- Name: "mysvc",
- Subsets: [
- {
- Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
- Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
- },
- {
- Addresses: [{"ip": "10.10.3.3"}],
- Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
- },
- ]

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

subsets

The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

true

v1.EndpointSubset array

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

false

- -
-
-

v1.Volume

-
-

Volume represents a named volume in a pod that may be accessed by any container in the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

false

v1.HostPathVolumeSource

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

v1.SecretVolumeSource

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

photonPersistentDisk

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

false

v1.PhotonPersistentDiskVolumeSource

- -
-
-

v1.ResourceFieldSelector

-
-

ResourceFieldSelector represents container resources (cpu, memory) and their output format

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

- -
-
-

v1.Probe

-
-

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

- -
-
-

unversioned.APIResourceList

-
-

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key of the secret to select from. Must be a valid secret key.

true

string

- -
-
-

v1.ReplicationController

-
-

ReplicationController represents the configuration of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.ReplicationControllerSpec

status

Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.ReplicationControllerStatus

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

APIResource specifies the name of a resource and whether it is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

true

string

- -
-
-

v1.PodStatus

-
-

PodStatus represents information about the status of a pod. Status may trail the actual state of a system.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Current condition of the pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase

false

string

conditions

Current service state of pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions

false

v1.PodCondition array

message

A human readable message indicating details about why the pod is in this condition.

false

string

reason

A brief CamelCase message indicating details about why the pod is in this state. e.g. OutOfDisk

false

string

hostIP

IP address of the host to which the pod is assigned. Empty if not yet scheduled.

false

string

podIP

IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.

false

string

startTime

RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

false

string (date-time)

containerStatuses

The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses

false

v1.ContainerStatus array

- -
-
-

v1.LimitRange

-
-

LimitRange sets resource usage limits for each kind of resource in a Namespace.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the limits enforced. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.LimitRangeSpec

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

true

string

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.ResourceQuota

-
-

ResourceQuota sets aggregate quota restrictions enforced per namespace

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the desired quota. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaSpec

status

Status defines the actual enforced quota and its current usage. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaStatus

- -
-
-

v1.EventList

-
-

EventList is a list of events.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of events

true

v1.Event array

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details

false

v1.Handler

- -
-
-

v1.ReplicationControllerSpec

-
-

ReplicationControllerSpec is the specification of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

false

integer (int32)

minReadySeconds

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

false

integer (int32)

selector

Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

object

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

false

v1.PodTemplateSpec

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

- -
-
-

v1.NodeStatus

-
-

NodeStatus is information about the current status of a node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capacity

Capacity represents the total resources of a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity for more details.

false

object

allocatable

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

false

object

phase

NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase The field is never populated, and now is deprecated.

false

string

conditions

Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition

false

v1.NodeCondition array

addresses

List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses

false

v1.NodeAddress array

daemonEndpoints

Endpoints of daemons running on the Node.

false

v1.NodeDaemonEndpoints

nodeInfo

Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info

false

v1.NodeSystemInfo

images

List of container images on this node

false

v1.ContainerImage array

volumesInUse

List of attachable volumes in use (mounted) by the node.

false

v1.UniqueVolumeName array

volumesAttached

List of volumes that are attached to the node.

false

v1.AttachedVolume array

- -
-
-

v1.GlusterfsVolumeSource

-
-

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

- -
-
-

v1.AttachedVolume

-
-

AttachedVolume describes a volume attached to a node

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the attached volume

true

string

devicePath

DevicePath represents the device path where the volume should be available

true

string

- -
-
-

v1.EventSource

-
-

EventSource contains information for an event.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

component

Component from which the event is generated.

false

string

host

Node name on which the event is generated.

false

string

- -
-
-

v1.PodCondition

-
-

PodCondition contains details for the current condition of this pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type is the type of the condition. Currently only Ready. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions

true

string

status

Status is the status of the condition. Can be True, False, Unknown. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions

true

string

lastProbeTime

Last time we probed the condition.

false

string (date-time)

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string (date-time)

reason

Unique, one-word, CamelCase reason for the condition’s last transition.

false

string

message

Human-readable message indicating details about last transition.

false

string

- -
-
-

v1.RBDVolumeSource

-
-

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#rbd

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1.PhotonPersistentDiskVolumeSource

-
-

Represents a Photon Controller persistent disk resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdID

ID that identifies Photon Controller persistent disk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

versioned.Event

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

true

string

object

true

string

- -
-
-

v1.PodTemplate

-
-

PodTemplate describes a template for creating copies of a predefined pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

template

Template defines the pods that will be created from this pod template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodTemplateSpec

- -
-
-

v1.ServiceStatus

-
-

ServiceStatus represents the current status of a service.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

loadBalancer

LoadBalancer contains the current status of the load-balancer, if one is present.

false

v1.LoadBalancerStatus

- -
-
-

v1.NFSVolumeSource

-
-

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

path

Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

boolean

false

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.EndpointPort

-
-

EndpointPort is a tuple that describes a single port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.

false

string

port

The port number of the endpoint.

true

integer (int32)

protocol

The IP protocol for this port. Must be UDP or TCP. Default is TCP.

false

string

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

- -
-
-

v1.LoadBalancerStatus

-
-

LoadBalancerStatus represents the status of a load-balancer.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ingress

Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

false

v1.LoadBalancerIngress array

- -
-
-

v1.SecretList

-
-

SecretList is a list of Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

Items is a list of secret objects. More info: http://kubernetes.io/docs/user-guide/secrets

true

v1.Secret array

- -
-
-

v1.Container

-
-

A single application container that you want to run within a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

image

Docker image name. More info: http://kubernetes.io/docs/user-guide/images

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

List of environment variables to set in the container. Cannot be updated.

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md

false

v1.SecurityContext

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

false

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1.PersistentVolumeSpec

-
-

PersistentVolumeSpec is the specification of a persistent volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capacity

A description of the persistent volume’s resources and capacity. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity

false

object

gcePersistentDisk

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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

hostPath

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: http://kubernetes.io/docs/user-guide/volumes#hostpath

false

v1.HostPathVolumeSource

glusterfs

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

nfs

NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

v1.NFSVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

iscsi

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.

false

v1.ISCSIVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

flocker

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

false

v1.FlockerVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

photonPersistentDisk

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

false

v1.PhotonPersistentDiskVolumeSource

accessModes

AccessModes contains all ways the volume can be mounted. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes

false

v1.PersistentVolumeAccessMode array

claimRef

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: http://kubernetes.io/docs/user-guide/persistent-volumes#binding

false

v1.ObjectReference

persistentVolumeReclaimPolicy

What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#recycling-policy

false

string

- -
-
-

v1.ReplicationControllerStatus

-
-

ReplicationControllerStatus represents the current status of a replication controller.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

The number of pods that have labels matching the labels of the pod template of the replication controller.

false

integer (int32)

readyReplicas

The number of ready replicas for this replication controller.

false

integer (int32)

availableReplicas

The number of available replicas (ready for at least minReadySeconds) for this replication controller.

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed replication controller.

false

integer (int64)

conditions

Represents the latest available observations of a replication controller’s current state.

false

v1.ReplicationControllerCondition array

- -
-
-

v1.FinalizerName

- -
-
-

v1.ServicePort

-
-

ServicePort contains information on service’s port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

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.

false

string

protocol

The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.

false

string

port

The port that will be exposed by this service.

true

integer (int32)

targetPort

Number 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: http://kubernetes.io/docs/user-guide/services#defining-a-service

false

string

nodePort

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: http://kubernetes.io/docs/user-guide/services#type—nodeport

false

integer (int32)

- -
-
-

v1.ComponentCondition

-
-

Information about the condition of a component.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of condition for a component. Valid value: "Healthy"

true

string

status

Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

true

string

message

Message about the condition for a component. For example, information about a health check.

false

string

error

Condition error code for a component. For example, a health check error code.

false

string

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

v1.ScaleSpec

-
-

ScaleSpec describes the attributes of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

- -
-
-

v1.ComponentStatusList

-
-

Status of all the conditions for the component as a list of ComponentStatus objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of ComponentStatus objects.

true

v1.ComponentStatus array

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

true

string

- -
-
-

v1.ContainerStateTerminated

-
-

ContainerStateTerminated is a terminated state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exitCode

Exit status from the last termination of the container

true

integer (int32)

signal

Signal from the last termination of the container

false

integer (int32)

reason

(brief) reason from the last termination of the container

false

string

message

Message regarding the last termination of the container

false

string

startedAt

Time at which previous execution of the container started

false

string (date-time)

finishedAt

Time at which the container last terminated

false

string (date-time)

containerID

Container’s ID in the format docker://<container_id>

false

string

- -
-
-

v1.Binding

-
-

Binding ties one object to another. For example, a pod is bound to a node by a scheduler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

target

The target object that you want to bind to the standard object.

true

v1.ObjectReference

- -
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.ContainerState

-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

waiting

Details about a waiting container

false

v1.ContainerStateWaiting

running

Details about a running container

false

v1.ContainerStateRunning

terminated

Details about a terminated container

false

v1.ContainerStateTerminated

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

boolean

false

- -
-
-

v1.ContainerStatus

-
-

ContainerStatus contains details for the current status of this container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

true

string

state

Details about the container’s current condition.

false

v1.ContainerState

lastState

Details about the container’s last termination condition.

false

v1.ContainerState

ready

Specifies whether the container has passed its readiness probe.

true

boolean

false

restartCount

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.

true

integer (int32)

image

The image the container is running. More info: http://kubernetes.io/docs/user-guide/images

true

string

imageID

ImageID of the container’s image.

true

string

containerID

Container’s ID in the format docker://<container_id>. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information

false

string

- -
-
-

v1.QuobyteVolumeSource

-
-

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

- -
-
-

v1.ContainerImage

-
-

Describe a container image

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

names

Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]

true

string array

sizeBytes

The size of the image in bytes.

false

integer (int64)

- -
-
-

v1.ResourceQuotaScope

- -
-
-

v1.ReplicationControllerList

-
-

ReplicationControllerList is a collection of replication controllers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of replication controllers. More info: http://kubernetes.io/docs/user-guide/replication-controller

true

v1.ReplicationController array

- -
-
-

v1.NodeDaemonEndpoints

-
-

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kubeletEndpoint

Endpoint on which Kubelet is listening.

false

v1.DaemonEndpoint

- -
-
-

v1.Secret

-
-

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

data

Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. 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

false

object

stringData

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.

false

object

type

Used to facilitate programmatic handling of secret data.

false

string

- -
-
-

v1.Event

-
-

Event is a report of an event somewhere in the cluster.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

true

v1.ObjectMeta

involvedObject

The object that this event is about.

true

v1.ObjectReference

reason

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

false

string

message

A human-readable description of the status of this operation.

false

string

source

The component reporting this event. Should be a short machine understandable string.

false

v1.EventSource

firstTimestamp

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

false

string (date-time)

lastTimestamp

The time at which the most recent occurrence of this event was recorded.

false

string (date-time)

count

The number of times this event has occurred.

false

integer (int32)

type

Type of this event (Normal, Warning), new types could be added in the future

false

string

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.PersistentVolumeAccessMode

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

- -
-
-

v1.ComponentStatus

-
-

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

conditions

List of component conditions observed

false

v1.ComponentCondition array

- -
-
-

v1.LimitRangeItem

-
-

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of resource that this limit applies to.

false

string

max

Max usage constraints on this kind by resource name.

false

object

min

Min usage constraints on this kind by resource name.

false

object

default

Default resource requirement limit value by resource name if resource limit is omitted.

false

object

defaultRequest

DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

false

object

maxLimitRequestRatio

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.

false

object

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

- -
-
-

v1.PodList

-
-

PodList is a list of Pods.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of pods. More info: http://kubernetes.io/docs/user-guide/pods

true

v1.Pod array

- -
-
-

v1.ServiceList

-
-

ServiceList holds a list of services.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of services

true

v1.Service array

- -
-
-

v1.PersistentVolumeList

-
-

PersistentVolumeList is a list of PersistentVolume items.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of persistent volumes. More info: http://kubernetes.io/docs/user-guide/persistent-volumes

true

v1.PersistentVolume array

- -
-
-

v1.ObjectReference

-
-

ObjectReference contains enough information to let you inspect or modify the referred object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

namespace

Namespace of the referent. More info: http://kubernetes.io/docs/user-guide/namespaces

false

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

apiVersion

API version of the referent.

false

string

resourceVersion

Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

fieldPath

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.

false

string

- -
-
-

unversioned.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

v1.ContainerStateWaiting

-
-

ContainerStateWaiting is a waiting state of a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

(brief) reason the container is not yet running.

false

string

message

Message regarding why the container is not yet running.

false

string

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key to select.

true

string

- -
-
-

v1.NodeSystemInfo

-
-

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

machineID

MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html

true

string

systemUUID

SystemUUID reported by the node. For unique machine identification MachineID is prefered. 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

true

string

bootID

Boot ID reported by the node.

true

string

kernelVersion

Kernel Version reported by the node from uname -r (e.g. 3.16.0-0.bpo.4-amd64).

true

string

osImage

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

true

string

containerRuntimeVersion

ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

true

string

kubeletVersion

Kubelet Version reported by the node.

true

string

kubeProxyVersion

KubeProxy Version reported by the node.

true

string

operatingSystem

The Operating System reported by the node

true

string

architecture

The Architecture reported by the node

true

string

- -
-
-

v1.ServiceSpec

-
-

ServiceSpec describes the attributes that a user creates on a service.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ports

The list of ports that are exposed by this service. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies

true

v1.ServicePort array

selector

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: http://kubernetes.io/docs/user-guide/services#overview

false

object

clusterIP

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: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies

false

string

type

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: http://kubernetes.io/docs/user-guide/services#overview

false

string

externalIPs

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. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.

false

string array

deprecatedPublicIPs

deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.

false

string array

sessionAffinity

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: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies

false

string

loadBalancerIP

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.

false

string

loadBalancerSourceRanges

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: http://kubernetes.io/docs/user-guide/services-firewalls

false

string array

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.

false

string

- -
-
-

v1.Pod

-
-

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

status

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodStatus

- -
-
-

v1.NodeSpec

-
-

NodeSpec describes the attributes that a node is created with.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podCIDR

PodCIDR represents the pod IP range assigned to the node.

false

string

externalID

External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.

false

string

providerID

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

false

string

unschedulable

Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration

false

boolean

false

- -
-
-

v1.EndpointAddress

-
-

EndpointAddress is a tuple that describes single IP address.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

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.

true

string

hostname

The Hostname of this endpoint

false

string

nodeName

Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

false

string

targetRef

Reference to object providing the endpoint.

false

v1.ObjectReference

- -
-
-

v1.DaemonEndpoint

-
-

DaemonEndpoint contains information about a single Daemon endpoint.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

Port

Port number of the given endpoint.

true

integer (int32)

- -
-
-

v1.AzureDataDiskCachingMode

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - diff --git a/_includes/v1.5/v1-operations.html b/_includes/v1.5/v1-operations.html deleted file mode 100755 index c56782a6b5470..0000000000000 --- a/_includes/v1.5/v1-operations.html +++ /dev/null @@ -1,32969 +0,0 @@ - - - - - - -Operations - - - -
-
-

Operations

-
-
-

get available resources

-
-
-
GET /api/v1
-
-
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

unversioned.APIResourceList

- -
-
-

Consumes

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list objects of kind ComponentStatus

-
-
-
GET /api/v1/componentstatuses
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ComponentStatusList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ComponentStatus

-
-
-
GET /api/v1/componentstatuses/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the ComponentStatus

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ComponentStatus

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ConfigMap

-
-
-
GET /api/v1/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMapList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Endpoints

-
-
-
GET /api/v1/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EndpointsList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Event

-
-
-
GET /api/v1/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EventList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind LimitRange

-
-
-
GET /api/v1/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRangeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Namespace

-
-
-
GET /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.NamespaceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Namespace

-
-
-
DELETE /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Namespace

-
-
-
POST /api/v1/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Binding

-
-
-
POST /api/v1/namespaces/{namespace}/bindings
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Binding

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ConfigMap

-
-
-
GET /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMapList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ConfigMap

-
-
-
DELETE /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ConfigMap

-
-
-
POST /api/v1/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ConfigMap

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ConfigMap

-
-
-
GET /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ConfigMap

-
-
-
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ConfigMap

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ConfigMap

-
-
-
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ConfigMap

-
-
-
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ConfigMap

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Endpoints

-
-
-
GET /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EndpointsList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Endpoints

-
-
-
DELETE /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create Endpoints

-
-
-
POST /api/v1/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Endpoints

-
-
-
GET /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Endpoints

-
-
-
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Endpoints

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete Endpoints

-
-
-
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Endpoints

-
-
-
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Endpoints

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Event

-
-
-
GET /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.EventList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Event

-
-
-
DELETE /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create an Event

-
-
-
POST /api/v1/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Event

-
-
-
GET /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Event

-
-
-
PUT /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Event

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete an Event

-
-
-
DELETE /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Event

-
-
-
PATCH /api/v1/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Event

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind LimitRange

-
-
-
GET /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRangeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of LimitRange

-
-
-
DELETE /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a LimitRange

-
-
-
POST /api/v1/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified LimitRange

-
-
-
GET /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified LimitRange

-
-
-
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.LimitRange

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a LimitRange

-
-
-
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified LimitRange

-
-
-
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.LimitRange

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaimList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PersistentVolumeClaim

-
-
-
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PersistentVolumeClaim

-
-
-
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PersistentVolumeClaim

-
-
-
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PersistentVolumeClaim

-
-
-
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PersistentVolumeClaim

-
-
-
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified PersistentVolumeClaim

-
-
-
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified PersistentVolumeClaim

-
-
-
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolumeClaim

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified PersistentVolumeClaim

-
-
-
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaim

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Pod

-
-
-
PATCH /api/v1/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to attach of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to attach of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

stderr

Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.

false

boolean

QueryParameter

container

The container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create binding of a Binding

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Binding

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Binding

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Binding

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create eviction of an Eviction

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.Eviction

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Eviction

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1beta1.Eviction

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to exec of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to exec of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read log of the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/log
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

container

The container for which to stream logs. Defaults to only container if there is one container in the pod.

false

string

QueryParameter

follow

Follow the log stream of the pod. Defaults to false.

false

boolean

QueryParameter

previous

Return previous terminated container logs. Defaults to false.

false

boolean

QueryParameter

sinceSeconds

A 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.

false

integer (int32)

QueryParameter

sinceTime

An RFC3339 timestamp 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.

false

string

QueryParameter

timestamps

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

false

boolean

QueryParameter

tailLines

If 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

false

integer (int32)

QueryParameter

limitBytes

If 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.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    text/plain

    -
    • -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to portforward of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to portforward of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Pod

-
-
-
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Pod

-
-
-
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Pod

-
-
-
GET /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Pod

-
-
-
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Pod

-
-
-
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Pod

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PodTemplate

-
-
-
GET /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PodTemplate

-
-
-
DELETE /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PodTemplate

-
-
-
POST /api/v1/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PodTemplate

-
-
-
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PodTemplate

-
-
-
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PodTemplate

-
-
-
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PodTemplate

-
-
-
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ReplicationController

-
-
-
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ReplicationController

-
-
-
POST /api/v1/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ReplicationController

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ReplicationController

-
-
-
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ReplicationController

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read scale of the specified Scale

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace scale of the specified Scale

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update scale of the specified Scale

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Scale

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified ReplicationController

-
-
-
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified ReplicationController

-
-
-
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified ReplicationController

-
-
-
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ResourceQuota

-
-
-
DELETE /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ResourceQuota

-
-
-
POST /api/v1/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ResourceQuota

-
-
-
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ResourceQuota

-
-
-
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ResourceQuota

-
-
-
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified ResourceQuota

-
-
-
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified ResourceQuota

-
-
-
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified ResourceQuota

-
-
-
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Secret

-
-
-
GET /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.SecretList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Secret

-
-
-
DELETE /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Secret

-
-
-
POST /api/v1/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Secret

-
-
-
GET /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Secret

-
-
-
PUT /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Secret

-
-
-
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Secret

-
-
-
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Secret

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ServiceAccount

-
-
-
GET /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of ServiceAccount

-
-
-
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a ServiceAccount

-
-
-
POST /api/v1/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified ServiceAccount

-
-
-
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified ServiceAccount

-
-
-
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a ServiceAccount

-
-
-
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified ServiceAccount

-
-
-
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Service

-
-
-
GET /api/v1/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Service

-
-
-
POST /api/v1/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Service

-
-
-
PATCH /api/v1/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Service

-
-
-
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Service

-
-
-
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Service

-
-
-
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path 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.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Service

-
-
-
GET /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Service

-
-
-
PUT /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Service

-
-
-
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Service

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Namespace

-
-
-
GET /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Namespace

-
-
-
DELETE /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Namespace

-
-
-
PATCH /api/v1/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace finalize of the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}/finalize
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Namespace

-
-
-
GET /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Namespace

-
-
-
PUT /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Namespace

-
-
-
PATCH /api/v1/namespaces/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Namespace

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Node

-
-
-
GET /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.NodeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of Node

-
-
-
DELETE /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a Node

-
-
-
POST /api/v1/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified Node

-
-
-
GET /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified Node

-
-
-
PUT /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a Node

-
-
-
DELETE /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified Node

-
-
-
PATCH /api/v1/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Node

-
-
-
GET /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Node

-
-
-
PUT /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Node

-
-
-
DELETE /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Node

-
-
-
POST /api/v1/nodes/{name}/proxy
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect GET requests to proxy of Node

-
-
-
GET /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect PUT requests to proxy of Node

-
-
-
PUT /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect DELETE requests to proxy of Node

-
-
-
DELETE /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

connect POST requests to proxy of Node

-
-
-
POST /api/v1/nodes/{name}/proxy/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified Node

-
-
-
GET /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified Node

-
-
-
PUT /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified Node

-
-
-
PATCH /api/v1/nodes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.Node

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolumeClaim

-
-
-
GET /api/v1/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaimList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PersistentVolume

-
-
-
GET /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete collection of PersistentVolume

-
-
-
DELETE /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

create a PersistentVolume

-
-
-
POST /api/v1/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read the specified PersistentVolume

-
-
-
GET /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace the specified PersistentVolume

-
-
-
PUT /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

delete a PersistentVolume

-
-
-
DELETE /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

QueryParameter

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int32)

QueryParameter

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

unversioned.Status

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update the specified PersistentVolume

-
-
-
PATCH /api/v1/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

read status of the specified PersistentVolume

-
-
-
GET /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

replace status of the specified PersistentVolume

-
-
-
PUT /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

partially update status of the specified PersistentVolume

-
-
-
PATCH /api/v1/persistentvolumes/{name}/status
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

- -
-
-

Consumes

-
-
    -
  • -

    application/json-patch+json

    -
    • -
  • -

    application/merge-patch+json

    -
    • -
  • -

    application/strategic-merge-patch+json

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Pod

-
-
-
GET /api/v1/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind PodTemplate

-
-
-
GET /api/v1/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Pod

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Pod

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Pod

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Pod

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Pod

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Pod

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Pod

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Pod

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Service

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Service

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Service

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Service

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Service

-
-
-
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Service

-
-
-
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Service

-
-
-
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Service

-
-
-
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Node

-
-
-
GET /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Node

-
-
-
PUT /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Node

-
-
-
DELETE /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Node

-
-
-
POST /api/v1/proxy/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy GET requests to Node

-
-
-
GET /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy PUT requests to Node

-
-
-
PUT /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy DELETE requests to Node

-
-
-
DELETE /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

proxy POST requests to Node

-
-
-
POST /api/v1/proxy/nodes/{name}/{path}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

default

success

string

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ReplicationController

-
-
-
GET /api/v1/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ResourceQuota

-
-
-
GET /api/v1/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Secret

-
-
-
GET /api/v1/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.SecretList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind ServiceAccount

-
-
-
GET /api/v1/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

list or watch objects of kind Service

-
-
-
GET /api/v1/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ConfigMap

-
-
-
GET /api/v1/watch/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Endpoints

-
-
-
GET /api/v1/watch/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Event

-
-
-
GET /api/v1/watch/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of LimitRange

-
-
-
GET /api/v1/watch/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Namespace

-
-
-
GET /api/v1/watch/namespaces
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ConfigMap

-
-
-
GET /api/v1/watch/namespaces/{namespace}/configmaps
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ConfigMap

-
-
-
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Endpoints

-
-
-
GET /api/v1/watch/namespaces/{namespace}/endpoints
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Endpoints

-
-
-
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Event

-
-
-
GET /api/v1/watch/namespaces/{namespace}/events
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Event

-
-
-
GET /api/v1/watch/namespaces/{namespace}/events/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of LimitRange

-
-
-
GET /api/v1/watch/namespaces/{namespace}/limitranges
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind LimitRange

-
-
-
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolumeClaim

-
-
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PersistentVolumeClaim

-
-
-
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Pod

-
-
-
GET /api/v1/watch/namespaces/{namespace}/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Pod

-
-
-
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PodTemplate

-
-
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PodTemplate

-
-
-
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicationController

-
-
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ReplicationController

-
-
-
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ResourceQuota

-
-
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ResourceQuota

-
-
-
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Secret

-
-
-
GET /api/v1/watch/namespaces/{namespace}/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Secret

-
-
-
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ServiceAccount

-
-
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind ServiceAccount

-
-
-
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Service

-
-
-
GET /api/v1/watch/namespaces/{namespace}/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Service

-
-
-
GET /api/v1/watch/namespaces/{namespace}/services/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Namespace

-
-
-
GET /api/v1/watch/namespaces/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Namespace

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Node

-
-
-
GET /api/v1/watch/nodes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind Node

-
-
-
GET /api/v1/watch/nodes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Node

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolumeClaim

-
-
-
GET /api/v1/watch/persistentvolumeclaims
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PersistentVolume

-
-
-
GET /api/v1/watch/persistentvolumes
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch changes to an object of kind PersistentVolume

-
-
-
GET /api/v1/watch/persistentvolumes/{name}
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the PersistentVolume

true

string

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Pod

-
-
-
GET /api/v1/watch/pods
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of PodTemplate

-
-
-
GET /api/v1/watch/podtemplates
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ReplicationController

-
-
-
GET /api/v1/watch/replicationcontrollers
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ResourceQuota

-
-
-
GET /api/v1/watch/resourcequotas
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Secret

-
-
-
GET /api/v1/watch/secrets
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of ServiceAccount

-
-
-
GET /api/v1/watch/serviceaccounts
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-

watch individual changes to a list of Service

-
-
-
GET /api/v1/watch/services
-
-
-
-

Parameters

- -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

- -
-
-

Responses

- ----- - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

success

versioned.Event

- -
-
-

Consumes

-
-
    -
  • -

    /

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json

    -
    • -
  • -

    application/yaml

    -
    • -
  • -

    application/vnd.kubernetes.protobuf

    -
    • -
  • -

    application/json;stream=watch

    -
    • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
    • -
-
-
-
-

Tags

-
-
    -
  • -

    apiv1

    -
    • -
-
-
-
-
-
-
- - - \ No newline at end of file diff --git a/_layouts/docsportal.html b/_layouts/docsportal.html new file mode 100644 index 0000000000000..e247cd5e08cb4 --- /dev/null +++ b/_layouts/docsportal.html @@ -0,0 +1,66 @@ + + + +{% include head.html %} + + + +{% include header.html %} + + +
+

{{ toc.bigheader }}

+
{{ toc.abstract }}
+
+ + +
+
+ +{% include deprecation-warning.html %} + +
+ + +
+ + {{ content }} + +
+

Analytics

+ {% if page.url != "/404.html" and page.url != "/docs/search/" %} + {% unless page.no_issue %} + + Create an Issue + {% endunless %} + {% unless page.noedit %} + Edit this Page + {% endunless %} + {% endif %} +
+
+
+ +{% include_cached footer.html %} +{% include footer-scripts.html %} + + + diff --git a/_layouts/docwithnav.html b/_layouts/docwithnav.html index 924d0c3822265..50ff09d7ff579 100755 --- a/_layouts/docwithnav.html +++ b/_layouts/docwithnav.html @@ -56,19 +56,19 @@

{{ page.title }}

Analytics

{% if page.url != "/404.html" and page.url != "/docs/search/"%} - {% unless page.no_issue %} + {% unless page.no_issue %} - Create an Issue - {% endunless %} + {% endunless %} {% unless page.noedit %} Edit this Page {% endunless %} diff --git a/_plugins/README.md b/_plugins/README.md index ba8d00ca3e67d..0294efaf5b751 100644 --- a/_plugins/README.md +++ b/_plugins/README.md @@ -25,7 +25,7 @@ This renders the definition of the glossary term inside a `
`, preserving Ma | Name | Default | Description | | --- | --- | --- | -| `term_id` | N/A (Required) | The `id` of the glossary term whose definition will be used. (This `id` is the same as the filename of the term, i.e. `_data/glossary/.yml`.) | +| `term_id` | Not Applicable (Required) | The `id` of the glossary term whose definition will be used. (This `id` is the same as the filename of the term, i.e. `_data/glossary/.yml`.) | | `length` | "short" | Specifies which term definition should be used ("short" for the `short-definition`, "long" for `long-description`, "all" when both should be included). | | `prepend` | "Service Catalog is" | A prefix which can be attached in front of a term's short definition (which is one or more sentence fragments). | @@ -49,7 +49,7 @@ This renders the following: | Name | Default | Description | | --- | --- | --- | | `text` | the `name` of the glossary term | The text that the user will hover over to display the glossary definition. **You should include this if using the tooltip inside of a glossary term's YAML short-definition.** | -| `term_id` | N/A (Required) | The `id` of the associated glossary term. (This `id` is the same as the filename of the term, i.e. `_data/glossary/.yml`.) | +| `term_id` | Not Applicable (Required) | The `id` of the associated glossary term. (This `id` is the same as the filename of the term, i.e. `_data/glossary/.yml`.) | #### (3) `glossary_injector` tag @@ -73,6 +73,6 @@ This renders the following: | Name | Default | Description | | --- | --- | --- | | `text` | the `name` of the glossary term | The text that the user will hover over to display the glossary definition. | -| `term_id` | N/A (Required) | The `id` of the glossary term whose definition will be used. (This `id` is the same as the filename of the term, i.e. `_data/glossary/.yml`.) | -| `placeholder_id` | N/A (Required) | The `id` of the HTML element whose contents will be populated with the definition of `term_id` | +| `term_id` | Not Applicable (Required) | The `id` of the glossary term whose definition will be used. (This `id` is the same as the filename of the term, i.e. `_data/glossary/.yml`.) | +| `placeholder_id` | Not Applicable (Required) | The `id` of the HTML element whose contents will be populated with the definition of `term_id` | | `length` | "short" | Specifies which term definition should be used ("short" for the `short-definition`, "long" for `long-description`, "all" when both should be included). | diff --git a/_plugins/glossary_tags.rb b/_plugins/glossary_tags.rb index 8faaedfb3713a..2577a65403515 100644 --- a/_plugins/glossary_tags.rb +++ b/_plugins/glossary_tags.rb @@ -1,3 +1,4 @@ +require 'pry' # See /_plugins/README.md for full documentation of these custom Jekyll tags module Jekyll module GlossaryTags @@ -89,7 +90,7 @@ def render(context) gsub(NESTED_MARKDOWN_LINKS, '\2'). strip - "" \ + "" \ "#{@args[:text] || term_info["name"]}" \ "" \ "#{tooltip}" \ diff --git a/_redirects b/_redirects index 5594352713445..48d26e389267d 100644 --- a/_redirects +++ b/_redirects @@ -28,6 +28,7 @@ /docs/admin/garbage-collection/ /docs/concepts/cluster-administration/kubelet-garbage-collection/ 301 /docs/admin/ha-master-gce/ /docs/tasks/administer-cluster/highly-available-master/ 301 /docs/admin/ha-master-gce.md/ /docs/tasks/administer-cluster/highly-available-master/ 301 +/docs/admin/high-availability/ /docs/admin/high-availability/building/ 301 /docs/admin/kubeadm-upgrade-1-7/ /docs/tasks/administer-cluster/kubeadm-upgrade-1-7/ 301 /docs/admin/limitrange/ /docs/tasks/administer-cluster/cpu-memory-limit/ 301 /docs/admin/limitrange/Limits/ /docs/tasks/administer-cluster/limit-storage-consumption/#limitrange-to-limit-requests-for-storage/ 301 @@ -49,7 +50,7 @@ /docs/admin/resourcequota/limitstorageconsumption/ /docs/tasks/administer-cluster/limit-storage-consumption/ 301 /docs/admin/resourcequota/walkthrough/ /docs/tasks/administer-cluster/quota-api-object/ 301 /docs/admin/static-pods/ /docs/tasks/administer-cluster/static-pod/ 301 -/docs/admin/sysctls/ /docs/concepts/cluster-administration/sysctl-cluster/ 301 +/docs/admin/sysctls/ /docs/tasks/administer-cluster/sysctl-cluster/ 301 /docs/admin/upgrade-1-6/ /docs/tasks/administer-cluster/upgrade-1-6/ 301 /docs/admin/resource-quota/ /docs/concepts/policy/resource-quotas/ 301 @@ -70,14 +71,13 @@ /docs/api-reference/policy/v1beta1/definitions/ https://v1-4.docs.kubernetes.io/docs/api-reference/policy/v1beta1/definitions/ 301 /docs/api-reference/README/ https://v1-4.docs.kubernetes.io/docs/api-reference/README/ 301 /docs/api-reference/storage.k8s.io/v1beta1/operations/ https://v1-4.docs.kubernetes.io/docs/api-reference/storage.k8s.io/v1beta1/operations/ 301 -/docs/api-reference/v1.4/* https://v1-4.docs.kubernetes.io/docs/reference/ 301 -/docs/api-reference/1_5/* https://v1-5.docs.kubernetes.io/docs/reference/ 301 -/docs/api-reference/v1.5/* https://v1-5.docs.kubernetes.io/docs/reference/ 301 /docs/api-reference/v1.6/* https://v1-6.docs.kubernetes.io/docs/reference/ 301 /docs/api-reference/v1.7/* https://v1-7.docs.kubernetes.io/docs/reference/ 301 /docs/api-reference/v1.8/* https://v1-8.docs.kubernetes.io/docs/api-reference/v1.8/:splat 301 +/docs/api-reference/v1.9/ /docs/reference/generated/kubernetes-api/v1.9/ 301 /docs/api-reference/v1/definitions/ /docs/api-reference/v1.9/ 301 /docs/api-reference/v1/operations/ /docs/api-reference/v1.9/ 301 +/docs/api-reference/v1.9/ /docs/reference/generated/kubernetes-api/v1.9/ 301 /docs/concepts/abstractions/controllers/garbage-collection/ /docs/concepts/workloads/controllers/garbage-collection/ 301 /docs/concepts/abstractions/controllers/statefulsets/ /docs/concepts/workloads/controllers/statefulset/ 301 @@ -97,6 +97,7 @@ /docs/concepts/cluster-administration/multiple-clusters/ /docs/concepts/cluster-administration/federation/ 301 /docs/concepts/cluster-administration/out-of-resource/ /docs/tasks/administer-cluster/out-of-resource/ 301 /docs/concepts/cluster-administration/resource-usage-monitoring /docs/tasks/debug-application-cluster/resource-usage-monitoring/ 301 +/docs/concepts/cluster-administration/sysctl-cluster/ /docs/tasks/administer-cluster/sysctl-cluster/ 301 /docs/concepts/cluster-administration/static-pod/ /docs/tasks/administer-cluster/static-pod/ 301 /docs/concepts/clusters/logging/ /docs/concepts/cluster-administration/logging/ 301 /docs/concepts/configuration/container-command-arg/ /docs/tasks/inject-data-application/define-command-argument-container/ 301 @@ -120,7 +121,6 @@ /docs/concepts/workloads/controllers/cron-jobs/deployment/ /docs/concepts/workloads/controllers/cron-jobs/ 301 /docs/concepts/workloads/controllers/daemonset/docs/concepts/workloads/pods/pod/ /docs/concepts/workloads/pods/pod/ 301 /docs/concepts/workloads/controllers/deployment/docs/concepts/workloads/pods/pod/ /docs/concepts/workloads/pods/pod/ 301 -/docs/concepts/workloads/controllers/deployment.md /docs/concepts/workloads/controllers/deployment/ 301 /docs/concepts/workloads/controllers/job/ /docs/concepts/workloads/controllers/jobs-run-to-completion/ 301 /docs/concepts/workloads/controllers/statefulsets/ /docs/concepts/workloads/controllers/statefulset/ 301 /docs/concepts/workloads/controllers/statefulset.md /docs/concepts/workloads/controllers/statefulset/ 301 @@ -177,7 +177,9 @@ /docs/getting-started-guides/ubuntu/automated/ /docs/getting-started-guides/ubuntu/ 301 /docs/getting-started-guides/ubuntu/calico/ /docs/getting-started-guides/ubuntu/ 301 /docs/getting-started-guides/vagrant/ /docs/getting-started-guides/alternatives/ 301 +/docs/getting-started-guides/vsphere/ https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/ 301 /docs/getting-started-guides/windows/While/ /docs/getting-started-guides/windows/ 301 +/docs/getting-started-guides/centos/* /docs/setup/independent/create-cluster-kubeadm/ 301 /docs/hellonode/ /docs/tutorials/stateless-application/hello-minikube/ 301 /docs/home/coreos/ /docs/getting-started-guides/coreos/ 301 @@ -193,9 +195,6 @@ /docs/reporting-security-issues/ /security/ 301 -/docs/resources-reference/1_5/* /docs/resources-reference/v1.5/ 301 -/docs/resources-reference/1_5/* https://v1-5.docs.kubernetes.io/docs/resources-reference/v1.5/ 301 -/docs/resources-reference/v1.5/node_modules/* https://v1-5.docs.kubernetes.io/docs/resources-reference/v1.5/ 301 /docs/resources-reference/1_6/* /docs/resources-reference/v1.6/ 301 /docs/resources-reference/1_7/* /docs/resources-reference/v1.7/ 301 /docs/resources-reference/v1.8/* /docs/api-reference/v1.8/:splat 301 @@ -289,9 +288,9 @@ /docs/user-guide/application-troubleshooting/ /docs/tasks/debug-application-cluster/debug-application/ 301 /docs/user-guide/compute-resources/ /docs/concepts/configuration/manage-compute-resources-container/ 301 /docs/user-guide/config-best-practices/ /docs/concepts/configuration/overview/ 301 -/docs/user-guide/configmap/ /docs/tasks/configure-pod-container/configmap/ 301 +/docs/user-guide/configmap/ /docs/tasks/configure-pod-container/configure-pod-configmap/ 301 /docs/user-guide/configmap/README/ /docs/tasks/configure-pod-container/configure-pod-configmap/ 301 -/docs/user-guide/configuring-containers/ /docs/tasks/configure-pod-container/configmap/ 301 +/docs/user-guide/configuring-containers/ /docs/tasks/configure-pod-container/configure-pod-configmap/ 301 /docs/user-guide/connecting-applications/ /docs/concepts/services-networking/connect-applications-service/ 301 /docs/user-guide/connecting-to-applications-port-forward/ /docs/tasks/access-application-cluster/port-forward-access-application-cluster/ 301 /docs/user-guide/connecting-to-applications-proxy/ /docs/tasks/access-kubernetes-api/http-proxy-access-api/ 301 @@ -347,9 +346,7 @@ /docs/user-guide/kubectl/v1.9/* /docs/reference/generated/kubectl/kubectl-commands/:splat 301 /docs/user-guide/kubectl-conventions/ /docs/reference/kubectl/conventions/ /docs/user-guide/kubectl-cheatsheet/ /docs/reference/kubectl/cheatsheet/ -/docs/user-guide/kubectl/1_5/* https://v1-5.docs.kubernetes.io/docs/user-guide/kubectl/v1.5/ 301 /docs/user-guide/kubectl/kubectl_*/ /docs/reference/generated/kubectl/kubectl-commands#:splat 301 -/docs/user-guide/kubectl/v1.5/node_modules/* https://v1-5.docs.kubernetes.io/docs/user-guide/kubectl/v1.5/ 301 /docs/user-guide/kubectl/v1.6/node_modules/* https://v1-6.docs.kubernetes.io/docs/user-guide/kubectl/v1.6/ 301 /docs/user-guide/labels/ /docs/concepts/overview/working-with-objects/labels/ 301 /docs/user-guide/liveness/ /docs/tasks/configure-pod-container/configure-liveness-readiness-probes/ 301 diff --git a/case-studies/amadeus.html b/case-studies/amadeus.html new file mode 100644 index 0000000000000..0e3b0726d3a2c --- /dev/null +++ b/case-studies/amadeus.html @@ -0,0 +1,105 @@ +--- +title: Amadeus Case Study +layout: basic +case_study_styles: true +cid: caseStudies +css: /css/style_amadeus.css +--- + +
+

CASE STUDY:
Another Technical Evolution for a 30-Year-Old Company +

+
+
+ Company  Amadeus IT Group     Location  Madrid, Spain     Industry  Travel Technology +
+
+
+
+
+

Challenge

+ In the past few years, Amadeus, which provides IT solutions to the travel industry around the world, found itself in need of a new platform for the 5,000 services supported by its service-oriented architecture. The 30-year-old company operates its own data center in Germany, and there were growing demands internally and externally for solutions that needed to be geographically dispersed. And more generally, "we had objectives of being even more highly available," says Eric Mountain, Senior Expert, Distributed Systems at Amadeus. Among the company’s goals: to increase automation in managing its infrastructure, optimize the distribution of workloads, use data center resources more efficiently, and adopt new technologies more easily. +
+
+

Solution

+ Mountain has been overseeing the company’s migration to Kubernetes, using OpenShift Container Platform, Red Hat’s enterprise container platform. +

+

Impact

+ One of the first projects the team deployed in Kubernetes was the Amadeus Airline Cloud Availability solution, which helps manage ever-increasing flight-search volume. "It’s now handling in production several thousand transactions per second, and it’s deployed in multiple data centers throughout the world," says Mountain. "It’s not a migration of an existing workload; it’s a whole new workload that we couldn’t have done otherwise. [This platform] gives us access to market opportunities that we didn’t have before." +
+
+
+ +
+
+ "We want multi-data center capabilities, and we want them for our mainstream system as well. We didn’t think that we could achieve them with our existing system. We need new automation, things that Kubernetes and OpenShift bring."

- Eric Mountain, Senior Expert, Distributed Systems at Amadeus IT Group +
+
+
+ +
+

In his two decades at Amadeus, Eric Mountain has been the migrations guy.

+ Back in the day, he worked on the company’s move from Unix to Linux, and now he’s overseeing the journey to cloud native. "Technology just keeps changing, and we embrace it," he says. "We are celebrating our 30 years this year, and we continue evolving and innovating to stay cost-efficient and enhance everyone’s travel experience, without interrupting workflows for the customers who depend on our technology."

+ That was the challenge that Amadeus—which provides IT solutions to the travel industry around the world, from flight searches to hotel bookings to customer feedback—faced in 2014. The technology team realized it was in need of a new platform for the 5,000 services supported by its service-oriented architecture.

+ The tipping point occurred when they began receiving many requests, internally and externally, for solutions that needed to be geographically outside the company’s main data center in Germany. "Some requests were for running our applications on customer premises," Mountain says. "There were also new services we were looking to offer that required response time to the order of a few hundred milliseconds, which we couldn’t achieve with transatlantic traffic. Or at least, not without eating into a considerable portion of the time available to our applications for them to process individual queries."

+ More generally, the company was interested in leveling up on high availability, increasing automation in managing infrastructure, optimizing the distribution of workloads and using data center resources more efficiently. "We have thousands and thousands of servers," says Mountain. "These servers are assigned roles, so even if the setup is highly automated, the machine still has a given role. It’s wasteful on many levels. For instance, an application doesn’t necessarily use the machine very optimally. Virtualization can help a bit, but it’s not a silver bullet. If that machine breaks, you still want to repair it because it has that role and you can’t simply say, ‘Well, I’ll bring in another machine and give it that role.’ It’s not fast. It’s not efficient. So we wanted the next level of automation."

+
+
+ +
+
+ "We hope that if we build on what others have built, what we do might actually be upstream-able. As Kubernetes and OpenShift progress, we see that we are indeed able to remove some of the additional layers we implemented to compensate for gaps we perceived earlier." +
+
+ +
+
+ While mainly a C++ and Java shop, Amadeus also wanted to be able to adopt new technologies more easily. Some of its developers had started using languages like Python and databases like Couchbase, but Mountain wanted still more options, he says, "in order to better adapt our technical solutions to the products we offer, and open up entirely new possibilities to our developers." Working with recent technologies and cool new things would also make it easier to attract new talent. +

+ All of those needs led Mountain and his team on a search for a new platform. "We did a set of studies and proofs of concept over a fairly short period, and we considered many technologies," he says. "In the end, we were left with three choices: build everything on premise, build on top of Kubernetes whatever happens to be missing from our point of view, or go with OpenShift and build whatever remains there." +

+ The team decided against building everything themselves—though they’d done that sort of thing in the past—because "people were already inventing things that looked good," says Mountain. +

+ Ultimately, they went with OpenShift Container Platform, Red Hat’s Kubernetes-based enterprise offering, instead of building on top of Kubernetes because "there was a lot of synergy between what we wanted and the way Red Hat was anticipating going with OpenShift," says Mountain. "They were clearly developing Kubernetes, and developing certain things ahead of time in OpenShift, which were important to us, such as more security." +

+ The hope was that those particular features would eventually be built into Kubernetes, and, in the case of security, Mountain feels that has happened. "We realize that there’s always a certain amount of automation that we will probably have to develop ourselves to compensate for certain gaps," says Mountain. "The less we do that, the better for us. We hope that if we build on what others have built, what we do might actually be upstream-able. As Kubernetes and OpenShift progress, we see that we are indeed able to remove some of the additional layers we implemented to compensate for gaps we perceived earlier." +
+
+ +
+
+ "It’s not a migration of an existing workload; it’s a whole new workload that we couldn’t have done otherwise. [This platform] gives us access to market opportunities that we didn’t have before." +
+
+ +
+
+ The first project the team tackled was one that they knew had to run outside the data center in Germany. Because of the project’s needs, "We couldn’t rely only on the built-in Kubernetes service discovery; we had to layer on top of that an extra service discovery level that allows us to load balance at the operation level within our system," says Mountain. They also built a stream dedicated to monitoring, which at the time wasn’t offered in the Kubernetes or OpenShift ecosystem. Now that Prometheus and other products are available, Mountain says the company will likely re-evaluate their monitoring system: "We obviously always like to leverage what Kubernetes and OpenShift can offer." +

+ The second project ended up going into production first: the Amadeus Airline Cloud Availability solution, which helps manage ever-increasing flight-search volume and was deployed in public cloud. Launched in early 2016, it is "now handling in production several thousand transactions per second, and it’s deployed in multiple data centers throughout the world," says Mountain. "It’s not a migration of an existing workload; it’s a whole new workload that we couldn’t have done otherwise. [This platform] gives us access to market opportunities that we didn’t have before." +

+ Having been through this kind of technical evolution more than once, Mountain has advice on how to handle the cultural changes. "That’s one aspect that we can tackle progressively," he says. "We have to go on supplying our customers with new features on our pre-existing products, and we have to keep existing products working. So we can’t simply do absolutely everything from one day to the next. And we mustn’t sell it that way." +

+ The first order of business, then, is to pick one or two applications to demonstrate that the technology works. Rather than choosing a high-impact, high-risk project, Mountain’s team selected a smaller application that was representative of all the company’s other applications in its complexity: "We just made sure we picked something that’s complex enough, and we showed that it can be done." +
+
+ +
+
+ "The bottom line is we want these multi-data center capabilities, and we want them as well for our mainstream system," he says. "And we don’t think that we can implement them with our previous system. We need the new automation, homogeneity, and scale that Kubernetes and OpenShift bring." +
+
+ +
+
+ Next comes convincing people. "On the operations side and on the R&D side, there will be people who say quite rightly, ‘There is a system, and it works, so why change?’" Mountain says. "The only thing that really convinces people is showing them the value." For Amadeus, people realized that the Airline Cloud Availability product could not have been made available on the public cloud with the company’s existing system. The question then became, he says, "Do we go into a full-blown migration? Is that something that is justified?" +

+ "The bottom line is we want these multi-data center capabilities, and we want them as well for our mainstream system," he says. "And we don’t think that we can implement them with our previous system. We need the new automation, homogeneity, and scale that Kubernetes and OpenShift bring." +

+ So how do you get everyone on board? "Make sure you have good links between your R&D and your operations," he says. "Also make sure you’re going to talk early on to the investors and stakeholders. Figure out what it is that they will be expecting from you, that will convince them or not, that this is the right way for your company." +

+ His other advice is simply to make the technology available for people to try it. "Kubernetes and OpenShift Origin are open source software, so there’s no complicated license key for the evaluation period and you’re not limited to 30 days," he points out. "Just go and get it running." Along with that, he adds, "You’ve got to be prepared to rethink how you do things. Of course making your applications as cloud native as possible is how you’ll reap the most benefits: 12 factors, CI/CD, which is continuous integration, continuous delivery, but also continuous deployment." +

+ And while they explore that aspect of the technology, Mountain and his team will likely be practicing what he preaches to others taking the cloud native journey. "See what happens when you break it, because it’s important to understand the limits of the system," he says. Or rather, he notes, the advantages of it. "Breaking things on Kube is actually one of the nice things about it—it recovers. It’s the only real way that you’ll see that you might be able to do things." +
+
diff --git a/case-studies/blackrock.html b/case-studies/blackrock.html index fff28aa92aa41..670c990c3a347 100644 --- a/case-studies/blackrock.html +++ b/case-studies/blackrock.html @@ -24,13 +24,13 @@

CASE STUDY:

Challenge

- The world’s largest asset manager, BlackRock operates a very controlled static deployment scheme, which has allowed for scalability over the years. But in their data science division, there was a need for more dynamic access to resources. "We want to be able to give every investor access to data science, meaning Python notebooks, or even something much more advanced, like a MapReduce engine based on Spark," says Michael Francis, a Managing Director in BlackRock’s Product Group, which runs the company’s investment management platform. "Managing complex Python installations on users’ desktops is really hard because everyone ends up with slightly different environments. We have existing environments that do these things, but we needed to make it real, expansive and scaleable. Being able to spin that up on demand, tear it down, make that much more dynamic, became a critical thought process for us. It’s not so much that we had to solve our main core production problem, it’s how do we extend that? How do we evolve?" + The world’s largest asset manager, BlackRock operates a very controlled static deployment scheme, which has allowed for scalability over the years. But in their data science division, there was a need for more dynamic access to resources. "We want to be able to give every investor access to data science, meaning Python notebooks, or even something much more advanced, like a MapReduce engine based on Spark," says Michael Francis, a Managing Director in BlackRock’s Product Group, which runs the company’s investment management platform. "Managing complex Python installations on users’ desktops is really hard because everyone ends up with slightly different environments. We have existing environments that do these things, but we needed to make it real, expansive and scalable. Being able to spin that up on demand, tear it down, make that much more dynamic, became a critical thought process for us. It’s not so much that we had to solve our main core production problem, it’s how do we extend that? How do we evolve?"

Solution

Drawing from what they learned during a pilot done last year using Docker environments, Francis put together a cross-sectional team of 20 to build an investor research web app using Kubernetes with the goal of getting it into production within one quarter. -
+

Impact

"Our goal was: How do you give people tools rapidly without having to install them on their desktop?" says Francis. And the team hit the goal within 100 days. Francis is pleased with the results and says, "We’re going to use this infrastructure for lots of other application workloads as time goes on. It’s not just data science; it’s this style of application that needs the dynamism. But I think we’re 6-12 months away from making a [large scale] decision. We need to gain experience of running the system in production, we need to understand failure modes and how best to manage operational issues. What’s interesting is that just having this technology there is changing the way our developers are starting to think about their future development." @@ -65,7 +65,7 @@

Impact

- Still, challenges remain. "If you have a shared cluster, you get this storming herd problem where everyone wants to do the same thing at the same time," says Francis. "You could put limits on it, but you’d have to build an infrastructure to define limits for our processes, and the Python notebooks weren’t really designed for that. We have existing environments that do these things, but we needed to make it real, expansive, and scaleable. Being able to spin that up on demand, tear it down, and make that much more dynamic, became a critical thought process for us."

+ Still, challenges remain. "If you have a shared cluster, you get this storming herd problem where everyone wants to do the same thing at the same time," says Francis. "You could put limits on it, but you’d have to build an infrastructure to define limits for our processes, and the Python notebooks weren’t really designed for that. We have existing environments that do these things, but we needed to make it real, expansive, and scalable. Being able to spin that up on demand, tear it down, and make that much more dynamic, became a critical thought process for us."

Made up of managers from technology, infrastructure, production operations, development and information security, Francis’s team was able to look at the problem holistically and come up with a solution that made sense for BlackRock. "Our initial straw man was that we were going to build everything using Ansible and run it all using some completely different distributed environment," says Francis. "That would have been absolutely the wrong thing to do. Had we gone off on our own as the dev team and developed this solution, it would have been a very different product. And it would have been very expensive. We would not have gone down the route of running under our existing orchestration system. Because we don’t understand it. These guys [in operations and infrastructure] understand it. Having the multidisciplinary team allowed us to get to the right solutions and that actually meant we didn’t build anywhere near the amount we thought we were going to end up building."

In search of a solution in which they could manage usage on a user-by-user level, Francis’s team gravitated to Red Hat’s OpenShift Kubernetes offering. The company had already experimented with other cloud-native environments, but the team liked that Kubernetes was open source, and "we felt the winds were blowing in the direction of Kubernetes long term," says Francis. "Typically we make technology choices that we believe are going to be here in 5-10 years’ time, in some form. And right now, in this space, Kubernetes feels like the one that’s going to be there." Adds Uri Morris, Vice President of Production Operations: "When you see that the non-Google committers to Kubernetes overtook the Google committers, that’s an indicator of the momentum."

Once that decision was made, the major challenge was figuring out how to make Kubernetes work within BlackRock’s existing framework. "It’s about understanding how we can operate, manage and support a platform like this, in addition to tacking it onto our existing technology platform," says Project Manager Michael Maskallis. "All the controls we have in place, the change management process, the software development lifecycle, onboarding processes we go through—how can we do all these things?"

diff --git a/case-studies/haufegroup.html b/case-studies/haufegroup.html new file mode 100644 index 0000000000000..c7db9b4703b2f --- /dev/null +++ b/case-studies/haufegroup.html @@ -0,0 +1,112 @@ +--- +title: Haufe Group Case Study +layout: basic +case_study_styles: true +cid: caseStudies +css: /css/style_haufegroup.css +--- + + +
+

CASE STUDY:
Paving the Way for Cloud Native for Midsize Companies

+ +
+ +
+ Company  Haufe Group     Location  Freiburg, Germany     Industry  Media and Software +
+ +
+ +
+ +
+
+

Challenge

+ Founded in 1930 as a traditional publisher, Haufe Group has grown into a media and software company with 95 percent of its sales from digital products. Over the years, the company has gone from having "hardware in the basement" to outsourcing its infrastructure operations and IT. More recently, the development of new products, from Internet portals for tax experts to personnel training software, has created demands for increased speed, reliability and scalability. "We need to be able to move faster," says Solution Architect Martin Danielsson. "Adapting workloads is something that we really want to be able to do." +
+
+

Solution

+ Haufe Group began its cloud-native journey when Microsoft Azure became available in Europe; the company needed cloud deployments for its desktop apps with bandwidth-heavy download services. "After that, it has been different projects trying out different things," says Danielsson. Two years ago, Holger Reinhardt joined Haufe Group as CTO and rapidly re-oriented the traditional host provider-based approach toward a cloud and API-first strategy. +
+
+ A core part of this strategy was a strong mandate to embrace infrastructure-as-code across the entire software deployment lifecycle via Docker. The company is now getting ready to go live with two services in production using Kubernetes orchestration on Microsoft Azure and Amazon Web Services. The team is also working on breaking up one of their core Java Enterprise desktop products into microservices to allow for better evolvability and dynamic scaling in the cloud. +
+
+

Impact

+ With the ability to adapt workloads, Danielsson says, teams "will be able to scale down to around half the capacity at night, saving 30 percent of the hardware cost." Plus, shorter release times have had a major impact. "Before, we had to announce at least a week in advance when we wanted to do a release because there was a huge checklist of things that you had to do," he says. "By going cloud native, we have the infrastructure in place to be able to automate all of these things. Now we can get a new release done in half an hour instead of days." + +
+
+ +
+ +
+
+ "Over the next couple of years, people won’t even think that much about it when they want to run containers. Kubernetes is going to be the go-to solution."

- Martin Danielsson, Solution Architect, Haufe Group +
+
+ +
+ +
+

More than 80 years ago, Haufe Group was founded as a traditional publishing company, printing books and commentary on paper.

By the 1990s, though, the company’s leaders recognized that the future was digital, and to their credit, were able to transform Haufe Group into a media and software business that now gets 95 percent of its sales from digital products. "Among the German companies doing this, we were one of the early adopters," says Martin Danielsson, Solution Architect for Haufe Group.

+ And now they’re leading the way for midsize companies embracing cloud-native technology like Kubernetes. "The really big companies like Ticketmaster and Google get it right, and the startups get it right because they’re faster," says Danielsson. "We’re in this big lump of companies in the middle with a lot of legacy, a lot of structure, a lot of culture that does not easily fit the cloud technologies. We’re just 1,500 people, but we have hundreds of customer-facing applications. So we’re doing things that will be relevant for many companies of our size or even smaller."

+ Many of those legacy challenges stemmed from simply following the technology trends of the times. "We used to do full DevOps," he says. In the 1990s and 2000s, "that meant that you had your hardware in the basement. And then 10 years ago, the hype of the moment was to outsource application operations, outsource everything, and strip down your IT department to take away the distraction of all these hardware things. That’s not our area of expertise. We didn’t want to be an infrastructure provider. And now comes the backlash of that."

+ Haufe Group began feeling the pain as they were developing more new products, from Internet portals for tax experts to personnel training software, that have created demands for increased speed, reliability and scalability. "Right now, we have this break in workflows, where we go from writing concepts to developing, handing it over to production and then handing that over to your host provider," he says. "And then when things go bad we have no clue what went wrong. We definitely want to take back control, and we want to move a lot faster. Adapting workloads is something that we really want to be able to do."

+ Those needs led them to explore cloud-native technology. Their first foray into the cloud was doing deployments in Microsoft Azure, once it became available in Europe, for desktop products that had built-in download services. Hosting expenses for such bandwidth-heavy services were too high, so the company turned to the cloud. "After that, it has been different projects trying out different things," says Danielsson. +
+
+ +
+
+ "We have been doing containers for the last two years, and we really got the hang of how they work," says Danielsson. "But it was always for development and test, never in production, because we didn’t fully understand how that would work. And to me, Kubernetes was definitely the technology that solved that." +
+
+ +
+
+ + Two years ago, Holger Reinhardt joined Haufe Group as CTO and rapidly re-oriented the traditional host provider-based approach toward a cloud and API-first strategy. A core part of this strategy was a strong mandate to embrace infrastructure-as-code across the entire software deployment lifecycle via Docker. + Some experiments went further than others; German regulations about sensitive data proved to be a road block in moving some workloads to Azure and Amazon Web Services. "Due to our history, Germany is really strict with things like personally identifiable data," Danielsson says.

+ These experiments took on new life with the arrival of the Azure Sovereign Cloud for Germany (an Azure clone run by the German T-Systems provider). With the availability of Azure.de—which conforms to Germany’s privacy regulations—teams started to seriously consider deploying production loads in Docker into the cloud. "We have been doing containers for the last two years, and we really got the hang of how they work," says Danielsson. "But it was always for development and test, never in production, because we didn’t fully understand how that would work. And to me, Kubernetes was definitely the technology that solved that."

+ In parallel, Danielsson had built an API management system with the aim of supporting CI/CD scenarios, aspects of which were missing in off-the-shelf API management products. With a foundation based on Mashape’s Kong gateway, it is open-sourced as wicked.haufe.io. He put wicked.haufe.io to use with his product team.

Otherwise, Danielsson says his philosophy was "don’t try to reinvent the wheel all the time. Go for what’s there and 99 percent of the time it will be enough. And if you think you really need something custom or additional, think perhaps once or twice again. One of the things that I find so amazing with this cloud-native framework is that everything ties in."

+ Currently, Haufe Group is working on two projects using Kubernetes in production. One is a new mobile application for researching legislation and tax laws. "We needed a way to take out functionality from a legacy core and put an application on top of that with an API gateway—a lot of moving parts that screams containers," says Danielsson. So the team moved the build pipeline away from "deploying to some old, huge machine that you could deploy anything to" and onto a Kubernetes cluster where there would be automatic CI/CD "with feature branches and all these things that were a bit tedious in the past." +
+
+ +
+
+ "Before, we had to announce at least a week in advance when we wanted to do a release because there was a huge checklist of things that you had to do," says Danielsson. "By going cloud native, we have the infrastructure in place to be able to automate all of these things. Now we can get a new release done in half an hour instead of days." +
+
+ +
+
+ It was a proof of concept effort, and the proof was in the pudding. "Everyone was really impressed at what we accomplished in a week," says Danielsson. "We did these kinds of integrations just to make sure that we got a handle on how Kubernetes works. If you can create optimism and buzz around something, it’s half won. And if the developers and project managers know this is working, you’re more or less done." Adds Reinhardt: "You need to create some very visible, quick wins in order to overcome the status quo."

+ The impact on the speed of deployment was clear: "Before, we had to announce at least a week in advance when we wanted to do a release because there was a huge checklist of things that you had to do," says Danielsson. "By going cloud native, we have the infrastructure in place to be able to automate all of these things. Now we can get a new release done in half an hour instead of days."

+ The potential impact on cost was another bonus. "Hosting applications is quite expensive, so moving to the cloud is something that we really want to be able to do," says Danielsson. With the ability to adapt workloads, teams "will be able to scale down to around half the capacity at night, saving 30 percent of the hardware cost."

+ Just as importantly, Danielsson says, there’s added flexibility: "When we try to move or rework applications that are really crucial, it’s often tricky to validate whether the path we want to take is going to work out well. In order to validate that, we would need to reproduce the environment and really do testing, and that’s prohibitively expensive and simply not doable with traditional host providers. Cloud native gives us the ability to do risky changes and validate them in a cost-effective way."

+ As word of the two successful test projects spread throughout the company, interest in Kubernetes has grown. "We want to be able to support our developers in running Kubernetes clusters but we’re not there yet, so we allow them to do it as long as they’re aware that they are on their own," says Danielsson. "So that’s why we are also looking at things like [the managed Kubernetes platform] CoreOS Tectonic, Azure Container Service, ECS, etc. These kinds of services will be a lot more relevant to midsize companies that want to leverage cloud native but don’t have the IT departments or the structure around that."

+ In the next year and a half, Danielsson says the company will be working on moving one of their legacy desktop products, a web app for researching legislation and tax laws originally built in Java Enterprise, onto cloud-native technology. "We’re doing a microservice split out right now so that we can independently deploy the different parts," he says. The main website, which provides free content for customers, is also moving to cloud native. + +
+
+ +
+
+ "the execution of a strategy requires alignment of culture, structure and technology. Only if those three dimensions are aligned can you successfully execute a transformation into microservices and cloud-native architectures. And it is only then that the Cloud will pay the dividends in much faster speeds in product innovation and much lower operational costs." + +
+
+ +
+
+ But with these goals, Danielsson believes there are bigger cultural challenges that need to be constantly addressed. The move to new technology, not to mention a shift toward DevOps, means a lot of change for employees. "The roles were rather fixed in the past," he says. "You had developers, you had project leads, you had testers. And now you get into these really, really important things like test automation. Testers aren’t actually doing click testing anymore, and they have to write automated testing. And if you really want to go full-blown CI/CD, all these little pieces have to work together so that you get the confidence to do a check in, and know this check in is going to land in production, because if I messed up, some test is going to break. This is a really powerful thing because whatever you do, whenever you merge something into the trunk or to the master, this is going live. And that’s where you either get the people or they run away screaming." + Danielsson understands that it may take some people much longer to get used to the new ways.

+ "Culture is nothing that you can force on people," he says. "You have to live it for yourself. You have to evangelize. You have to show the advantages time and time again: This is how you can do it, this is what you get from it." To that end, his team has scheduled daylong workshops for the staff, bringing in outside experts to talk about everything from API to Devops to cloud.

+ For every person who runs away screaming, many others get drawn in. "Get that foot in the door and make them really interested in this stuff," says Danielsson. "Usually it catches on. We have people you never would have expected chanting, ‘Docker Docker Docker’ now. It’s cool to see them realize that there is a world outside of their Python libraries. It’s awesome to see them really work with Kubernetes."

+ Ultimately, Reinhardt says, "the execution of a strategy requires alignment of culture, structure and technology. Only if those three dimensions are aligned can you successfully execute a transformation into microservices and cloud-native architectures. And it is only then that the Cloud will pay the dividends in much faster speeds in product innovation and much lower operational costs." + +
+
diff --git a/case-studies/huawei.html b/case-studies/huawei.html new file mode 100644 index 0000000000000..d298f2753eae8 --- /dev/null +++ b/case-studies/huawei.html @@ -0,0 +1,101 @@ +--- +title: Huawei Case Study +layout: basic +case_study_styles: true +cid: caseStudies +css: /css/style_huawei.css +--- +
+

CASE STUDY:
Embracing Cloud Native as a User – and a Vendor

+ +
+ +
+ Company  Huawei     Location  Shenzhen, China     Industry  Telecommunications Equipment +
+ +
+ +
+ +
+
+

Challenge

+ A multinational company that’s the largest telecommunications equipment manufacturer in the world, Huawei has more than 180,000 employees. In order to support its fast business development around the globe, Huawei has eight data centers for its internal I.T. department, which have been running 800+ applications in 100K+ VMs to serve these 180,000 users. With the rapid increase of new applications, the cost and efficiency of management and deployment of VM-based apps all became critical challenges for business agility. "It’s very much a distributed system so we found that managing all of the tasks in a more consistent way is always a challenge," says Peixin Hou, the company’s Chief Software Architect and Community Director for Open Source. "We wanted to move into a more agile and decent practice." +
+ +
+

Solution

+ After deciding to use container technology, Huawei began moving the internal I.T. department’s applications to run on Kubernetes. So far, about 30 percent of these applications have been transferred to cloud native. +
+
+

Impact

+ "By the end of 2016, Huawei’s internal I.T. department managed more than 4,000 nodes with tens of thousands containers using a Kubernetes-based Platform as a Service (PaaS) solution," says Hou. "The global deployment cycles decreased from a week to minutes, and the efficiency of application delivery has been improved 10 fold." For the bottom line, he says, "We also see significant operating expense spending cut, in some circumstances 20-30 percent, which we think is very helpful for our business." Given the results Huawei has had internally – and the demand it is seeing externally – the company has also built the technologies into FusionStage™, the PaaS solution it offers its customers. +
+ +
+ +
+ +
+
+ "If you’re a vendor, in order to convince your customer, you should use it yourself. Luckily because Huawei has a lot of employees, we can demonstrate the scale of cloud we can build using this technology."

- Peixin Hou, chief software architect and community director for open source +
+
+ +
+ +
+ Huawei’s Kubernetes journey began with one developer. + Over two years ago, one of the engineers employed by the networking and telecommunications giant became interested in Kubernetes, the technology for managing application containers across clusters of hosts, and started contributing to its open source community. As the technology developed and the community grew, he kept telling his managers about it.

+ And as fate would have it, at the same time, Huawei was looking for a better orchestration system for its internal enterprise I.T. department, which supports every business flow processing. "We have more than 180,000 employees worldwide, and a complicated internal procedure, so probably every week this department needs to develop some new applications," says Peixin Hou, Huawei’s Chief Software Architect and Community Director for Open Source. "Very often our I.T. departments need to launch tens of thousands of containers, with tasks running across thousands of nodes across the world. It’s very much a distributed system, so we found that managing all of the tasks in a more consistent way is always a challenge."

+ In the past, Huawei had used virtual machines to encapsulate applications, but "every time when we start a VM," Hou says, "whether because it’s a new service or because it was a service that was shut down because of some abnormal node functioning, it takes a lot of time." Huawei turned to containerization, so the timing was right to try Kubernetes. It took a year to adopt that engineer’s suggestion – the process "is not overnight," says Hou – but once in use, he says, "Kubernetes basically solved most of our problems. Before, the time of deployment took about a week, now it only takes minutes. The developers are happy. That department is also quite happy."

+ Hou sees great benefits to the company that come with using this technology: "Kubernetes brings agility, scale-out capability, and DevOps practice to the cloud-based applications," he says. "It provides us with the ability to customize the scheduling architecture, which makes possible the affinity between container tasks that gives greater efficiency. It supports multiple container formats. It has extensive support for various container networking solutions and container storage." +
+
+ +
+
+ "Kubernetes basically solved most of our problems. Before, the time of deployment took about a week, now it only takes minutes. The developers are happy. That department is also quite happy." +
+
+ +
+
+ And not least of all, there’s an impact on the bottom line. Says Hou: "We also see significant operating expense spending cut in some circumstances 20-30 percent, which is very helpful for our business."

+ Pleased with those initial results, and seeing a demand for cloud native technologies from its customers, Huawei doubled down on Kubernetes. In the spring of 2016, the company became not only a user but also a vendor.

+ "We built the Kubernetes technologies into our solutions," says Hou, referring to Huawei’s FusionStage™ PaaS offering. "Our customers, from very big telecommunications operators to banks, love the idea of cloud native. They like Kubernetes technology. But they need to spend a lot of time to decompose their applications to turn them into microservice architecture, and as a solution provider, we help them. We’ve started to work with some Chinese banks, and we see a lot of interest from our customers like China Mobile and Deutsche Telekom."

+ "If you’re just a user, you’re just a user," adds Hou. "But if you’re a vendor, in order to even convince your customers, you should use it yourself. Luckily because Huawei has a lot of employees, we can demonstrate the scale of cloud we can build using this technology. We provide customer wisdom." While Huawei has its own private cloud, many of its customers run cross-cloud applications using Huawei’s solutions. It’s a big selling point that most of the public cloud providers now support Kubernetes. "This makes the cross-cloud transition much easier than with other solutions," says Hou.

+
+
+ +
+
+ "Our customers, from very big telecommunications operators to banks, love the idea of cloud native. They like Kubernetes technology. But they need to spend a lot of time to decompose their applications to turn them into microservice architecture, and as a solution provider, we help them." +
+
+ +
+
+ Within Huawei itself, once his team completes the transition of the internal business procedure department to Kubernetes, Hou is looking to convince more departments to move over to the cloud native development cycle and practice. "We have a lot of software developers, so we will provide them with our platform as a service solution, our own product," he says. "We would like to see significant cuts in their iteration cycle."

+ Having overseen the initial move to Kubernetes at Huawei, Hou has advice for other companies considering the technology: "When you start to design the architecture of your application, think about cloud native, think about microservice architecture from the beginning," he says. "I think you will benefit from that."

+ But if you already have legacy applications, "start from some microservice-friendly part of those applications first, parts that are relatively easy to be decomposed into simpler pieces and are relatively lightweight," Hou says. "Don’t think from day one that within how many days I want to move the whole architecture, or move everything into microservices. Don’t put that as a kind of target. You should do it in a gradual manner. And I would say for legacy applications, not every piece would be suitable for microservice architecture. No need to force it."

+ After all, as enthusiastic as Hou is about Kubernetes at Huawei, he estimates that "in the next 10 years, maybe 80 percent of the workload can be distributed, can be run on the cloud native environments. There’s still 20 percent that’s not, but it’s fine. If we can make 80 percent of our workload really be cloud native, to have agility, it’s a much better world at the end of the day." + +
+
+ +
+
+ "In the next 10 years, maybe 80 percent of the workload can be distributed, can be run on the cloud native environments. There’s still 20 percent that’s not, but it’s fine. If we can make 80 percent of our workload really be cloud native, to have agility, it’s a much better world at the end of the day." + +
+
+
+
+ In the nearer future, Hou is looking forward to new features that are being developed around Kubernetes, not least of all the ones that Huawei is contributing to. Huawei engineers have worked on the federation feature (which puts multiple Kubernetes clusters in a single framework to be managed seamlessly), scheduling, container networking and storage, and a just-announced technology called Container Ops, which is a DevOps pipeline engine. "This will put every DevOps job into a container," he explains. "And then this container mechanism is running using Kubernetes, but is also used to test Kubernetes. With that mechanism, we can make the containerized DevOps jobs be created, shared and managed much more easily than before."

+ Still, Hou sees this technology as only halfway to its full potential. First and foremost, he’d like to expand the scale it can orchestrate, which is important for supersized companies like Huawei – as well as some of its customers.

+ Hou proudly notes that two years after that first Huawei engineer became a contributor to and evangelist for Kubernetes, Huawei is now a top contributor to the community. "We’ve learned that the more you contribute to the community," he says, "the more you get back." + +
+
diff --git a/case-studies/index.html b/case-studies/index.html index ba42783c54ad3..ee10a3168180b 100644 --- a/case-studies/index.html +++ b/case-studies/index.html @@ -14,29 +14,29 @@
A collection of users running Kubernetes in production.
-
- BlackRock -

"My message to other enterprises like us is you can actually integrate Kubernetes into an existing, well-orchestrated machinery."

- - Read about BlackRock +
+ amadeus +

"We didn’t think that we could achieve them with our existing system. We need new automation, things that Kubernetes and OpenShift bring."

+ + Read about Amadeus
- blablacar -

"[With Kubernetes] our infrastructure is much more resilient and we have better availability than before."

- - Read about BlaBlaCar + huawei +

"Kubernetes basically solved most of our problems. Before, the time of deployment took about a week, now it only takes minutes."

+ + Read about Huawei
- peardeck -

"In terms of the cloud, Kubernetes and Prometheus have so much to offer."

- - Read about Pear Deck + Haufe Group +

"Over the next couple of years, people won’t even think that much about it when they want to run containers. Kubernetes is going to be the go-to solution."

+ + Read about Haufe Group
- Buffer -

"It’s amazing that we can use the Kubernetes solution off the shelf with our team. And it just keeps getting better."

- - Read about Buffer + BlackRock +

"My message to other enterprises like us is you can actually integrate Kubernetes into an existing, well-orchestrated machinery."

+ + Read about BlackRock
@@ -59,7 +59,7 @@

"Kubernetes has the opportunity to be the new cloud platform. The amount

Kubernetes Users

- Amadeus + Amadeus Ancestry.com BlaBlaCar BlackRock @@ -71,6 +71,8 @@

Kubernetes Users

Ebay Goldman Sachs GolfNow + Haufe Group + Huawei JD.COM LivePerson monzo diff --git a/cn/docs/admin/authorization/abac.md b/cn/docs/admin/authorization/abac.md index bdf17e9c82601..a78cd4d0d824d 100644 --- a/cn/docs/admin/authorization/abac.md +++ b/cn/docs/admin/authorization/abac.md @@ -135,7 +135,7 @@ system:serviceaccount::default {"apiVersion":"abac.authorization.kubernetes.io/v1beta1","kind":"Policy","spec":{"user":"system:serviceaccount:kube-system:default","namespace":"*","resource":"*","apiGroup":"*"}} ``` -需要重新启动 apitorver 以获取新的策略行. +需要重新启动 apiserver 以获取新的策略行. {% endcapture %} {% include templates/concept.md %} diff --git a/cn/docs/concepts/cluster-administration/device-plugins.md b/cn/docs/concepts/cluster-administration/device-plugins.md index 656df45899017..9ba08c89155ab 100644 --- a/cn/docs/concepts/cluster-administration/device-plugins.md +++ b/cn/docs/concepts/cluster-administration/device-plugins.md @@ -58,7 +58,7 @@ service Registration { ```gRPC service DevicePlugin { // ListAndWatch returns a stream of List of Devices - // Whenever a Device state change or a Device disapears, ListAndWatch + // Whenever a Device state change or a Device disappears, ListAndWatch // returns the new list rpc ListAndWatch(Empty) returns (stream ListAndWatchResponse) {} diff --git a/cn/docs/concepts/containers/images.md b/cn/docs/concepts/containers/images.md index 19dfa52de4a6d..f630c443e98cf 100644 --- a/cn/docs/concepts/containers/images.md +++ b/cn/docs/concepts/containers/images.md @@ -195,7 +195,7 @@ $ kubectl describe pods/private-image-test-1 | grep "Failed" **注意:** Google Kubernetes Engine,GCE及其他自动创建node的云平台上，推荐使用本方法。 -Kuberentes支持在pod中指定仓库密钥。 +Kubernetes支持在pod中指定仓库密钥。 #### 使用Docker Config创建Secret diff --git a/cn/docs/concepts/overview/what-is-kubernetes.md b/cn/docs/concepts/overview/what-is-kubernetes.md index 46bce4b2f4c0f..2b0de77af654a 100644 --- a/cn/docs/concepts/overview/what-is-kubernetes.md +++ b/cn/docs/concepts/overview/what-is-kubernetes.md @@ -91,7 +91,7 @@ Kubernetes 提供了很多的功能，总会有新的场景受益于新特性。 [Label](/docs/user-guide/labels/) 允许用户按照自己的方式组织管理对应的资源。 [注解](/docs/user-guide/annotations/) 使用户能够以自定义的描述信息来修饰资源，以适用于自己的工作流，并为管理工具提供检查点状态的简单方法。 -此外，[Kubernetes 控制面 (Controll Plane)](/docs/admin/cluster-components) 是构建在相同的 [APIs](/docs/api/) 上面，开发人员和用户都可以用。用户可以编写自己的控制器， [调度器](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/scheduler.md)等等，如果这么做，根据新加的[自定义 API](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/extending-api.md) ，可以扩展当前的通用 [CLI 命令行工具](/docs/user-guide/kubectl-overview/)。 +此外，[Kubernetes 控制面 (Control Plane)](/docs/admin/cluster-components) 是构建在相同的 [APIs](/docs/api/) 上面，开发人员和用户都可以用。用户可以编写自己的控制器， [调度器](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/scheduler.md)等等，如果这么做，根据新加的[自定义 API](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/extending-api.md) ，可以扩展当前的通用 [CLI 命令行工具](/docs/user-guide/kubectl-overview/)。 这种 [设计](https://git.k8s.io/community/contributors/design-proposals/architecture/principles.md) 使得许多其他系统可以构建在 Kubernetes 之上。 diff --git a/cn/docs/concepts/overview/working-with-objects/kubernetes-objects.md b/cn/docs/concepts/overview/working-with-objects/kubernetes-objects.md index dc7a1701dd0fe..33a2507d42625 100644 --- a/cn/docs/concepts/overview/working-with-objects/kubernetes-objects.md +++ b/cn/docs/concepts/overview/working-with-objects/kubernetes-objects.md @@ -52,12 +52,12 @@ Kubernetes 系统读取 Deployment 规约，并启动我们所期望的该应用 ### 描述 Kubernetes 对象 -当创建 KUbernetes 对象时，必须提供对象的规约，用来描述该对象的期望状态，以及关于对象的一些基本信息（例如名称）。 -当使用 KUbernetes API 创建对象时（或者直接创建，或者基于`kubectl`），API 请求必须在请求体中包含 JSON 格式的信息。 +当创建 Kubernetes 对象时，必须提供对象的规约，用来描述该对象的期望状态，以及关于对象的一些基本信息（例如名称）。 +当使用 Kubernetes API 创建对象时（或者直接创建，或者基于`kubectl`），API 请求必须在请求体中包含 JSON 格式的信息。 **大多数情况下，需要在 .yaml 文件中为 `kubectl` 提供这些信息**。 `kubectl` 在发起 API 请求时，将这些信息转换成 JSON 格式。 -这里有一个 `.yaml` 示例文件，展示了 KUbernetes Deployment 的必需字段和对象规约： +这里有一个 `.yaml` 示例文件，展示了 Kubernetes Deployment 的必需字段和对象规约： {% include code.html language="yaml" file="nginx-deployment.yaml" ghlink="/docs/concepts/overview/working-with-objects/nginx-deployment.yaml" %} @@ -78,7 +78,7 @@ deployment "nginx-deployment" created ### 必需字段 -在想要创建的 KUbernetes 对象对应的 `.yaml` 文件中，需要配置如下的字段： +在想要创建的 Kubernetes 对象对应的 `.yaml` 文件中，需要配置如下的字段： * `apiVersion` - 创建该对象所使用的 Kubernetes API 的版本 * `kind` - 想要创建的对象的类型 diff --git a/cn/docs/concepts/services-networking/nginx-secure-app.yaml b/cn/docs/concepts/services-networking/nginx-secure-app.yaml index 9e4a16791e065..ec180a18df3d3 100644 --- a/cn/docs/concepts/services-networking/nginx-secure-app.yaml +++ b/cn/docs/concepts/services-networking/nginx-secure-app.yaml @@ -17,11 +17,14 @@ spec: selector: run: my-nginx --- -apiVersion: apps/v1beta1 +apiVersion: apps/v1 kind: Deployment metadata: name: my-nginx spec: + selector: + matchLabels: + run: my-nginx replicas: 1 template: metadata: diff --git a/cn/docs/concepts/services-networking/run-my-nginx.yaml b/cn/docs/concepts/services-networking/run-my-nginx.yaml index b3d8e336cdec0..76a879f5c4c24 100644 --- a/cn/docs/concepts/services-networking/run-my-nginx.yaml +++ b/cn/docs/concepts/services-networking/run-my-nginx.yaml @@ -1,8 +1,11 @@ -apiVersion: apps/v1beta1 +apiVersion: apps/v1 kind: Deployment metadata: name: my-nginx spec: + selector: + matchLabels: + run: my-nginx replicas: 2 template: metadata: diff --git a/cn/docs/getting-started-guides/centos/centos_manual_config.md b/cn/docs/getting-started-guides/centos/centos_manual_config.md deleted file mode 100644 index ac79f48dfcdd3..0000000000000 --- a/cn/docs/getting-started-guides/centos/centos_manual_config.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -approvers: -- thockin -title: CentOS ---- - -* TOC -{:toc} - -## 警告 - -本文档适用于Kubernetes 1.1.0，目前已经被[废弃](https://github.com/kubernetes/website/issues/1613)。相关内容请参阅最新版[指南](/docs/getting-started-guides/kubeadm/)。 - -## 前提条件 - -在CentOS上部署和配置Kubernetes，您需要在集群中拥有一台机器作为master节点，并拥有至少一台运行CentOS 7系统的主机作为集群节点（node）。 - -## 启动一个集群 - -本文档是一篇基于CentOS系统部署和配置Kubernetes的入门指南，内容涵盖一个手工的配置，以便于您了解所有的底层软件包、服务以及端口等信息。 - -Kubernetes由一系列服务构成，包括kube-apiserver、kube-scheduler、kube-controller-manager、kubelet以及kube-proxy等。这些服务由systemd管理，配置集中位于/etc/kubernetes。我们将在集群中的不同主机上部署不同的服务。其中，第一台主机，即centos-master，将被部署成为Kubernetes集群中的master节点。这台主机上将运行kube-apiserver、kube-controller-manager和kube-scheduler。 此外，master节点还将运行 _etcd_。集群中剩余的主机，即centos-minion-n节点，将运行kubelet、proxy、cadvisor和docker。 - -集群中的所有节点将运行flanneld来构建网络（networking overlay）。 - -**系统信息：** - -主机： - -请使用您真实环境中的信息替换以下配置中的各个主机IP - -```conf -centos-master = 192.168.121.9 -centos-minion-1 = 192.168.121.65 -centos-minion-2 = 192.168.121.66 -centos-minion-3 = 192.168.121.67 -``` - -**配置主机环境：** - -* 在集群所有节点上——centos-{master,minion-n}，创建包含以下配置信息的/etc/yum.repos.d/virt7-docker-common-release.repo文件。 - -```conf -[virt7-docker-common-release] -name=virt7-docker-common-release -baseurl=http://cbs.centos.org/repos/virt7-docker-common-release/x86_64/os/ -gpgcheck=0 -``` - -* 在集群所有节点上——centos-{master,minion-n}，安装Kubernetes、etcd和flanneld。这一过程也将同时在节点上安装docker和cadvisor。 - -```shell -yum -y install --enablerepo=virt7-docker-common-release kubernetes etcd flannel -``` - -* 将master节点和其他节点的主机名——IP映射添加到所有集群节点的/etc/hosts文件中（如果主机名已经在DNS中记录，则可略过此步） - -```shell -echo "192.168.121.9 centos-master -192.168.121.65 centos-minion-1 -192.168.121.66 centos-minion-2 -192.168.121.67 centos-minion-3" >> /etc/hosts -``` - -* 编辑/etc/kubernetes/config文件以保证在集群所有主机上都包含以下内容： - -```shell -# logging to stderr意为从systemd journal获取日志 -KUBE_LOGTOSTDERR="--logtostderr=true" - -# journal消息级别, 0代表debug -KUBE_LOG_LEVEL="--v=0" - -# 是否允许集群运行privileged docker containers -KUBE_ALLOW_PRIV="--allow-privileged=false" - -# 配置replication conrtoller和scheduler所需的kube-apiserver地址 -KUBE_MASTER="--master=http://centos-master:8080" -``` - -* 由于docker与一些防火墙规则不兼容，需要在master节点及其他集群节点上禁用防火墙。在CentOS系统上，需要首先禁用SELinux，进而才能禁用防火墙。 - -```shell -setenforce 0 -systemctl disable iptables-services firewalld -systemctl stop iptables-services firewalld -``` - -**配置master节点上的Kubernetes服务** - -* 编辑/etc/etcd/etcd.conf文件内容如下： - -```shell -# [member] -ETCD_NAME=default -ETCD_DATA_DIR="/var/lib/etcd/default.etcd" -ETCD_LISTEN_CLIENT_URLS="http://0.0.0.0:2379" - -#[cluster] -ETCD_ADVERTISE_CLIENT_URLS="http://0.0.0.0:2379" -``` - -* 编辑/etc/kubernetes/apiserver文件内容如下： - -```shell -# 本地服务器监听地址 -KUBE_API_ADDRESS="--address=0.0.0.0" - -# 本地服务器监听端口 -KUBE_API_PORT="--port=8080" - -# Kubelet监听端口 -KUBELET_PORT="--kubelet-port=10250" - -# 以逗号间隔的etcd集群中各个节点的地址 -KUBE_ETCD_SERVERS="--etcd-servers=http://centos-master:2379" - -# Kubernetes服务IP地址网段 -KUBE_SERVICE_ADDRESSES="--service-cluster-ip-range=10.254.0.0/16" - -# 请添加您需要的Kubernetes API Server启动参数 -KUBE_API_ARGS="" -``` - -* 启动ETCD并保存master节点的网络设置（network overlay configuration）： -**警告** 请根据您的真实环境配置网络信息！在本文环境中，`172.30.0.0/16`网段是可用的。 - -```shell -systemctl start etcd -etcdctl mkdir /kube-centos/network -etcdctl mk /kube-centos/network/config "{ \"Network\": \"172.30.0.0/16\", \"SubnetLen\": 24, \"Backend\": { \"Type\": \"vxlan\" } }" -``` - -* 在master节点上配置/etc/sysconfig/flanneld文件使用flannel覆盖Docker网络 (需要在其他集群节点上完成相同配置，详见下文): - -```shell -# Flanneld配置选项 - -# etcd url地址，指向运行etcd的服务器 -FLANNEL_ETCD_ENDPOINTS="http://centos-master:2379" - -# etcd配置秘钥，即flannel查询的配置秘钥 -# 用于网段分配 -FLANNEL_ETCD_PREFIX="/kube-centos/network" - -# 其它需要的Flannel启动参数 -#FLANNEL_OPTIONS="" -``` - -* 在master节点上启动相关服务： - -```shell -for SERVICES in etcd kube-apiserver kube-controller-manager kube-scheduler flanneld; do - systemctl restart $SERVICES - systemctl enable $SERVICES - systemctl status $SERVICES -done -``` - -**在集群其他节点上配置Kubernetes服务** - -***我们需要在集群其他节点上配置kubelet，启动kubelet和proxy服务*** - -* 编辑/etc/kubernetes/kubelet文件内容如下： - -```shell -# info server的服务地址 -KUBELET_ADDRESS="--address=0.0.0.0" - -# info server的监听端口 -KUBELET_PORT="--port=10250" - -# 本字段可以设置空值以使用真实的主机名 -# 注意节点序号（n） -KUBELET_HOSTNAME="--hostname-override=centos-minion-n" - -# api-server地址 -KUBELET_API_SERVER="--api-servers=http://centos-master:8080" - -# 添加您所需要的Kubelet参数 -KUBELET_ARGS="" -``` - -* 在所有节点上配置/etc/sysconfig/flanneld文件设置使用flannel覆盖Docker网络： - -```shell -# Flanneld配置选项 - -# etcd url地址，指向运行etcd的服务器 -FLANNEL_ETCD_ENDPOINTS="http://centos-master:2379" - -# etcd配置秘钥，即flannel查询的配置秘钥 -# 用于网段分配 -FLANNEL_ETCD_PREFIX="/kube-centos/network" - -# 其他需要配置的选项 -#FLANNEL_OPTIONS="" -``` - -* 在节点上启动相关服务（centos-minion-n） - -```shell -for SERVICES in kube-proxy kubelet flanneld docker; do - systemctl restart $SERVICES - systemctl enable $SERVICES - systemctl status $SERVICES -done -``` -* 配置kubectl - -```shell -kubectl config set-cluster default-cluster --server=http://centos-master:8080 -kubectl config set-context default-context --cluster=default-cluster --user=default-admin -kubectl config use-context default-context -``` - -*至此，Kubernetes在CentOS集群中的部署已经完成 ！* - -* 在centos-master节点上通过kubectl命令检查所有的Kubernetes节点已经到位 - -```shell -$ kubectl get nodes -NAME STATUS AGE VERSION -centos-minion-1 Ready 3d v1.6.0+fff5156 -centos-minion-2 Ready 3d v1.6.0+fff5156 -centos-minion-3 Ready 3d v1.6.0+fff5156 -``` - -**现在，Kubernetes集群已经正常运行！可以创建测试pod验证集群了！** - -## 支持级别 - - -IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level --------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -Bare-metal | custom | CentOS | flannel | [docs](/docs/getting-started-guides/centos/centos_manual_config) | | Community ([@coolsvap](https://github.com/coolsvap)) - -有关所有解决方案的支持级别信息，请参阅[解决方案列表](/docs/getting-started-guides/#table-of-solutions)。 diff --git a/cn/docs/getting-started-guides/coreos/bare_metal_offline.md b/cn/docs/getting-started-guides/coreos/bare_metal_offline.md deleted file mode 100644 index 8e9b0d9ceb667..0000000000000 --- a/cn/docs/getting-started-guides/coreos/bare_metal_offline.md +++ /dev/null @@ -1,708 +0,0 @@ ---- -approvers: -- erictune -- thockin -title: Offline ---- - -本文档介绍了如何在CoreOS系统上部署Kubernetes。主要针对需要在离线环境下部署的场景，无论您是真实部署前的POC测试还是由于应用程序受限必须在离线环境中使用，本文档都是适用的。 - -* TOC -{:toc} - - -## 前提条件 - -1. 安装了 *CentOS 6* 系统的PXE服务器 -2. 集群中需要至少两台物理裸机节点 - -## 概要设计 - -1. 管理tftp目录 - * /tftpboot/(coreos)(centos)(RHEL) - * /tftpboot/pxelinux.0/(MAC) -> 链接到Linux镜像配置文件 -2. 安装时更新pxelinux链接 -3. 更新DHCP配置，添加所需要部署的主机的相关信息 -4. 创建一个etcd集群 -5. 确保集群处于离线环境[etcd discovery tool](https://discovery.etcd.io/). -6. 安装配置CoreOS slave节点作为Kubernetes节点 - -## 本文档定义的一些变量 - -| Node Description | MAC | IP | -| :---------------------------- | :---------------: | :---------: | -| CoreOS/etcd/Kubernetes Master | d0:00:67:13:0d:00 | 10.20.30.40 | -| CoreOS Slave 1 | d0:00:67:13:0d:01 | 10.20.30.41 | -| CoreOS Slave 2 | d0:00:67:13:0d:02 | 10.20.30.42 | - - -## 设置PXELINUX CentOS - -请参阅[这篇指南](http://docs.fedoraproject.org/en-US/Fedora/7/html/Installation_Guide/ap-pxe-server.html)以了解完整的CentOS PXELINUX环境设置步骤。本节内容仅是上述指南文档的概要缩写版本。 - -1. 安装CentOS上所需要的相关软件包 - -```shell -sudo yum install tftp-server dhcp syslinux -``` - -2. 编辑`/etc/xinetd.d/tftp`文件以启用tftp服务 - -```conf -disable = no -``` - -3. 拷贝所需的syslinux镜像文件 - -```shell -su - -mkdir -p /tftpboot -cd /tftpboot -cp /usr/share/syslinux/pxelinux.0 /tftpboot -cp /usr/share/syslinux/menu.c32 /tftpboot -cp /usr/share/syslinux/memdisk /tftpboot -cp /usr/share/syslinux/mboot.c32 /tftpboot -cp /usr/share/syslinux/chain.c32 /tftpboot - -/sbin/service dhcpd start -/sbin/service xinetd start -/sbin/chkconfig tftp on -``` - -4. 设置默认引导菜单 - -```shell -mkdir /tftpboot/pxelinux.cfg -touch /tftpboot/pxelinux.cfg/default -``` - -5. 编辑默认引导菜单`/tftpboot/pxelinux.cfg/default` - -```conf -default menu.c32 -prompt 0 -timeout 15 -ONTIMEOUT local -display boot.msg - -MENU TITLE Main Menu - -LABEL local - MENU LABEL Boot local hard drive - LOCALBOOT 0 -``` - -至此，您应当已经配置好一个可用的PXELINUX环境用来运行CoreOS节点了。您可以使用VirtualBox或者在物理裸机上对PXELINUX环境所提供的服务进行验证。 - -## 添加CoreOS至PXE - -本节描述在已有PXELINUX环境的前提下，如何配置CoreOS镜像与之并存。 - -1. 查找或者创建TFTP根目录，后续所有步骤都将基于此目录。 - * 本文中我们假设`/tftpboot`是根目录。 -2. tftp根目录准备好后，我们将为CoreOS镜像创建一个新的目录结构。 -3. 下载由CoreOS团队提供的CoreOS PXE相关文件。 - -```shell -MY_TFTPROOT_DIR=/tftpboot -mkdir -p $MY_TFTPROOT_DIR/images/coreos/ -cd $MY_TFTPROOT_DIR/images/coreos/ -wget http://stable.release.core-os.net/amd64-usr/current/coreos_production_pxe.vmlinuz -wget http://stable.release.core-os.net/amd64-usr/current/coreos_production_pxe.vmlinuz.sig -wget http://stable.release.core-os.net/amd64-usr/current/coreos_production_pxe_image.cpio.gz -wget http://stable.release.core-os.net/amd64-usr/current/coreos_production_pxe_image.cpio.gz.sig -gpg --verify coreos_production_pxe.vmlinuz.sig -gpg --verify coreos_production_pxe_image.cpio.gz.sig -``` - -4. 再次编辑菜单`/tftpboot/pxelinux.cfg/default` - -```conf -default menu.c32 -prompt 0 -timeout 300 -ONTIMEOUT local -display boot.msg - -MENU TITLE Main Menu - -LABEL local - MENU LABEL Boot local hard drive - LOCALBOOT 0 - -MENU BEGIN CoreOS Menu - - LABEL coreos-master - MENU LABEL CoreOS Master - KERNEL images/coreos/coreos_production_pxe.vmlinuz - APPEND initrd=images/coreos/coreos_production_pxe_image.cpio.gz cloud-config-url=http:///pxe-cloud-config-single-master.yml - - LABEL coreos-slave - MENU LABEL CoreOS Slave - KERNEL images/coreos/coreos_production_pxe.vmlinuz - APPEND initrd=images/coreos/coreos_production_pxe_image.cpio.gz cloud-config-url=http:///pxe-cloud-config-slave.yml -MENU END -``` - -此文件配置了系统将从本地磁盘引导，但添加了从PXE CoreOS镜像引导的选项。 - -## DHCP配置 - -本节将介绍如何配置DHCP服务器分发新的镜像。这里我们假设集群中有其他的服务器需要从不同的CoreOS镜像引导。 - -1. 添加`filename`字段到 _host_ 或者 _subnet_ 部分。 - -```conf -filename "/tftpboot/pxelinux.0"; -``` - -2. 现在，我们可以创建pxelinux配置文件，这些配置将来也可以作为其他不同CoreOS部署的模版。 - -```conf -subnet 10.20.30.0 netmask 255.255.255.0 { - next-server 10.20.30.242; - option broadcast-address 10.20.30.255; - filename ""; - - ... - # http://www.syslinux.org/wiki/index.php/PXELINUX - host core_os_master { - hardware ethernet d0:00:67:13:0d:00; - option routers 10.20.30.1; - fixed-address 10.20.30.40; - option domain-name-servers 10.20.30.242; - filename "/pxelinux.0"; - } - host core_os_slave { - hardware ethernet d0:00:67:13:0d:01; - option routers 10.20.30.1; - fixed-address 10.20.30.41; - option domain-name-servers 10.20.30.242; - filename "/pxelinux.0"; - } - host core_os_slave2 { - hardware ethernet d0:00:67:13:0d:02; - option routers 10.20.30.1; - fixed-address 10.20.30.42; - option domain-name-servers 10.20.30.242; - filename "/pxelinux.0"; - } - ... -} -``` - -稍后我们将介绍节点的配置。 - -## Kubernetes - -部署以上配置前，需要首先创建一个`etcd`主节点(master)。为了做到这一点，我们需要使用一个特殊的cloud-config.yaml来pxe CoreOS，可以有两种方式： -1. 第一种方式是将云配置文件模版化，然后通过编程的方式为不同的集群提供不同的配置。 -2. 第二种方式是运行一个服务发现协议从而可以在云环境中做服务的自动发现。 - -在本示例中，我们将通过静态方式创建一个etcd服务器，用于运行Kubernetes主控组件，并用作etcd主节点。 - -由于我们的集群处于一个离线的环境中，所以大部分的CoreOS和Kubernetes帮助进程是受限的。为了完成部署，我们需要下载Kubernetes的各个可执行文件到本地然后再启动运行。 - -一种简单的方案是在DHCP/TFTP主机上搭建一个简易的web服务器，从而环境中的CoreOS PXE机器可以从其上下载各个可执行文件。 - -为了达到这一目标，我们将启动一个`apache`服务器并提供运行Kubernetes所需要的各个可执行文件。 - -以下脚本运行在上文中准备好的PXE服务器上： - -```shell -rm /etc/httpd/conf.d/welcome.conf -cd /var/www/html/ -wget -O kube-register https://github.com/kelseyhightower/kube-register/releases/download/v0.0.2/kube-register-0.0.2-linux-amd64 -wget -O setup-network-environment https://github.com/kelseyhightower/setup-network-environment/releases/download/v1.0.0/setup-network-environment -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kubernetes -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kube-apiserver -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kube-controller-manager -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kube-scheduler -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kubectl -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kubecfg -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kubelet -wget https://storage.googleapis.com/kubernetes-release/release/v0.15.0/bin/linux/amd64/kube-proxy -wget -O flanneld https://storage.googleapis.com/k8s/flanneld -``` - -以上脚本将准备好运行Kubernetes所需的所有可执行文件。未来这些文件将可通过互联网直接进行更新。 - -现在可以开始准备部署了！ - -## 云平台配置 - -以下Kubernetes离线版本部署配置文件经过了一定的裁减。 - -以下内容基于配置文件: [master.yml](/docs/getting-started-guides/coreos/cloud-configs/master.yaml), 以及[node.yml](/docs/getting-started-guides/coreos/cloud-configs/node.yaml) - -将文件中的一些占位字段做如下修改： - - - 使用您的PXE服务器的ip地址替换文件中的`` (例如10.20.30.242) - - 使用Kubernetes master节点的ip地址替换文件中的`` (例如10.20.30.40) - - 如果您使用私有docker镜像仓库，请使用您的镜像仓库DNS名字替换文件中的`rdocker.example.com` - - 如果您使用代理，请用代理服务器地址（包含端口）替换文件中的`rproxy.example.com` - - 在配置文件最后添加您的SSH公钥 - -### master.yml - -在PXE服务器上创建并编辑文件`/var/www/html/coreos/pxe-cloud-config-master.yml`。 - -```yaml -#cloud-config ---- -write_files: - - path: /opt/bin/waiter.sh - owner: root - content: | - #! /usr/bin/bash - until curl http://127.0.0.1:4001/v2/machines; do sleep 2; done - - path: /opt/bin/kubernetes-download.sh - owner: root - permissions: 0755 - content: | - #! /usr/bin/bash - /usr/bin/wget -N -P "/opt/bin" "http:///kubectl" - /usr/bin/wget -N -P "/opt/bin" "http:///kubernetes" - /usr/bin/wget -N -P "/opt/bin" "http:///kubecfg" - chmod +x /opt/bin/* - - path: /etc/profile.d/opt-path.sh - owner: root - permissions: 0755 - content: | - #! /usr/bin/bash - PATH=$PATH/opt/bin -coreos: - units: - - name: 10-eno1.network - runtime: true - content: | - [Match] - Name=eno1 - [Network] - DHCP=yes - - name: 20-nodhcp.network - runtime: true - content: | - [Match] - Name=en* - [Network] - DHCP=none - - name: get-kube-tools.service - runtime: true - command: start - content: | - [Service] - ExecStartPre=-/usr/bin/mkdir -p /opt/bin - ExecStart=/opt/bin/kubernetes-download.sh - RemainAfterExit=yes - Type=oneshot - - name: setup-network-environment.service - command: start - content: | - [Unit] - Description=Setup Network Environment - Documentation=https://github.com/kelseyhightower/setup-network-environment - Requires=network-online.target - After=network-online.target - [Service] - ExecStartPre=-/usr/bin/mkdir -p /opt/bin - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///setup-network-environment - ExecStartPre=/usr/bin/chmod +x /opt/bin/setup-network-environment - ExecStart=/opt/bin/setup-network-environment - RemainAfterExit=yes - Type=oneshot - - name: etcd.service - command: start - content: | - [Unit] - Description=etcd - Requires=setup-network-environment.service - After=setup-network-environment.service - [Service] - EnvironmentFile=/etc/network-environment - User=etcd - PermissionsStartOnly=true - ExecStart=/usr/bin/etcd \ - --name ${DEFAULT_IPV4} \ - --addr ${DEFAULT_IPV4}:4001 \ - --bind-addr 0.0.0.0 \ - --cluster-active-size 1 \ - --data-dir /var/lib/etcd \ - --http-read-timeout 86400 \ - --peer-addr ${DEFAULT_IPV4}:7001 \ - --snapshot true - Restart=always - RestartSec=10s - - name: fleet.socket - command: start - content: | - [Socket] - ListenStream=/var/run/fleet.sock - - name: fleet.service - command: start - content: | - [Unit] - Description=fleet daemon - Wants=etcd.service - After=etcd.service - Wants=fleet.socket - After=fleet.socket - [Service] - Environment="FLEET_ETCD_SERVERS=http://127.0.0.1:4001" - Environment="FLEET_METADATA=role=master" - ExecStart=/usr/bin/fleetd - Restart=always - RestartSec=10s - - name: etcd-waiter.service - command: start - content: | - [Unit] - Description=etcd waiter - Wants=network-online.target - Wants=etcd.service - After=etcd.service - After=network-online.target - Before=flannel.service - Before=setup-network-environment.service - [Service] - ExecStartPre=/usr/bin/chmod +x /opt/bin/waiter.sh - ExecStart=/usr/bin/bash /opt/bin/waiter.sh - RemainAfterExit=true - Type=oneshot - - name: flannel.service - command: start - content: | - [Unit] - Wants=etcd-waiter.service - After=etcd-waiter.service - Requires=etcd.service - After=etcd.service - After=network-online.target - Wants=network-online.target - Description=flannel is an etcd backed overlay network for containers - [Service] - Type=notify - ExecStartPre=-/usr/bin/mkdir -p /opt/bin - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///flanneld - ExecStartPre=/usr/bin/chmod +x /opt/bin/flanneld - ExecStartPre=-/usr/bin/etcdctl mk /coreos.com/network/config '{"Network":"10.100.0.0/16", "Backend": {"Type": "vxlan"}}' - ExecStart=/opt/bin/flanneld - - name: kube-apiserver.service - command: start - content: | - [Unit] - Description=Kubernetes API Server - Documentation=https://github.com/kubernetes/kubernetes - Requires=etcd.service - After=etcd.service - [Service] - ExecStartPre=-/usr/bin/mkdir -p /opt/bin - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///kube-apiserver - ExecStartPre=/usr/bin/chmod +x /opt/bin/kube-apiserver - ExecStart=/opt/bin/kube-apiserver \ - --address=0.0.0.0 \ - --port=8080 \ - --service-cluster-ip-range=10.100.0.0/16 \ - --etcd-servers=http://127.0.0.1:4001 \ - --logtostderr=true - Restart=always - RestartSec=10 - - name: kube-controller-manager.service - command: start - content: | - [Unit] - Description=Kubernetes Controller Manager - Documentation=https://github.com/kubernetes/kubernetes - Requires=kube-apiserver.service - After=kube-apiserver.service - [Service] - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///kube-controller-manager - ExecStartPre=/usr/bin/chmod +x /opt/bin/kube-controller-manager - ExecStart=/opt/bin/kube-controller-manager \ - --master=127.0.0.1:8080 \ - --logtostderr=true - Restart=always - RestartSec=10 - - name: kube-scheduler.service - command: start - content: | - [Unit] - Description=Kubernetes Scheduler - Documentation=https://github.com/kubernetes/kubernetes - Requires=kube-apiserver.service - After=kube-apiserver.service - [Service] - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///kube-scheduler - ExecStartPre=/usr/bin/chmod +x /opt/bin/kube-scheduler - ExecStart=/opt/bin/kube-scheduler --master=127.0.0.1:8080 - Restart=always - RestartSec=10 - - name: kube-register.service - command: start - content: | - [Unit] - Description=Kubernetes Registration Service - Documentation=https://github.com/kelseyhightower/kube-register - Requires=kube-apiserver.service - After=kube-apiserver.service - Requires=fleet.service - After=fleet.service - [Service] - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///kube-register - ExecStartPre=/usr/bin/chmod +x /opt/bin/kube-register - ExecStart=/opt/bin/kube-register \ - --metadata=role=node \ - --fleet-endpoint=unix:///var/run/fleet.sock \ - --healthz-port=10248 \ - --api-endpoint=http://127.0.0.1:8080 - Restart=always - RestartSec=10 - update: - group: stable - reboot-strategy: off -ssh_authorized_keys: - - ssh-rsa AAAAB3NzaC1yc2EAAAAD... -``` - -### node.yml - -在PXE服务器上创建并编辑文件`/var/www/html/coreos/pxe-cloud-config-slave.yml`。 - -```yaml -#cloud-config ---- -write_files: - - path: /etc/default/docker - content: | - DOCKER_EXTRA_OPTS='--insecure-registry="rdocker.example.com:5000"' -coreos: - units: - - name: 10-eno1.network - runtime: true - content: | - [Match] - Name=eno1 - [Network] - DHCP=yes - - name: 20-nodhcp.network - runtime: true - content: | - [Match] - Name=en* - [Network] - DHCP=none - - name: etcd.service - mask: true - - name: docker.service - drop-ins: - - name: 50-insecure-registry.conf - content: | - [Service] - Environment="HTTP_PROXY=http://rproxy.example.com:3128/" "NO_PROXY=localhost,127.0.0.0/8,rdocker.example.com" - - name: fleet.service - command: start - content: | - [Unit] - Description=fleet daemon - Wants=fleet.socket - After=fleet.socket - [Service] - Environment="FLEET_ETCD_SERVERS=http://:4001" - Environment="FLEET_METADATA=role=node" - ExecStart=/usr/bin/fleetd - Restart=always - RestartSec=10s - - name: flannel.service - command: start - content: | - [Unit] - After=network-online.target - Wants=network-online.target - Description=flannel is an etcd backed overlay network for containers - [Service] - Type=notify - ExecStartPre=-/usr/bin/mkdir -p /opt/bin - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///flanneld - ExecStartPre=/usr/bin/chmod +x /opt/bin/flanneld - ExecStart=/opt/bin/flanneld -etcd-endpoints http://:4001 - - name: docker.service - command: start - content: | - [Unit] - After=flannel.service - Wants=flannel.service - Description=Docker Application Container Engine - Documentation=http://docs.docker.io - [Service] - EnvironmentFile=-/etc/default/docker - EnvironmentFile=/run/flannel/subnet.env - ExecStartPre=/bin/mount --make-rprivate / - ExecStart=/usr/bin/docker -d --bip=${FLANNEL_SUBNET} --mtu=${FLANNEL_MTU} -s=overlay -H fd:// ${DOCKER_EXTRA_OPTS} - [Install] - WantedBy=multi-user.target - - name: setup-network-environment.service - command: start - content: | - [Unit] - Description=Setup Network Environment - Documentation=https://github.com/kelseyhightower/setup-network-environment - Requires=network-online.target - After=network-online.target - [Service] - ExecStartPre=-/usr/bin/mkdir -p /opt/bin - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///setup-network-environment - ExecStartPre=/usr/bin/chmod +x /opt/bin/setup-network-environment - ExecStart=/opt/bin/setup-network-environment - RemainAfterExit=yes - Type=oneshot - - name: kube-proxy.service - command: start - content: | - [Unit] - Description=Kubernetes Proxy - Documentation=https://github.com/kubernetes/kubernetes - Requires=setup-network-environment.service - After=setup-network-environment.service - [Service] - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///kube-proxy - ExecStartPre=/usr/bin/chmod +x /opt/bin/kube-proxy - ExecStart=/opt/bin/kube-proxy \ - --etcd-servers=http://:4001 \ - --logtostderr=true - Restart=always - RestartSec=10 - - name: kube-kubelet.service - command: start - content: | - [Unit] - Description=Kubernetes Kubelet - Documentation=https://github.com/kubernetes/kubernetes - Requires=setup-network-environment.service - After=setup-network-environment.service - [Service] - EnvironmentFile=/etc/network-environment - ExecStartPre=/usr/bin/wget -N -P /opt/bin http:///kubelet - ExecStartPre=/usr/bin/chmod +x /opt/bin/kubelet - ExecStart=/opt/bin/kubelet \ - --address=0.0.0.0 \ - --port=10250 \ - --hostname-override=${DEFAULT_IPV4} \ - --api-servers=:8080 \ - --healthz-bind-address=0.0.0.0 \ - --healthz-port=10248 \ - --logtostderr=true - Restart=always - RestartSec=10 - update: - group: stable - reboot-strategy: off -ssh_authorized_keys: - - ssh-rsa AAAAB3NzaC1yc2EAAAAD... -``` - -## 创建pxelinux.cfg相关文件 - -为 _slave_ 节点创建一个pxelinux目标文件： `vi /tftpboot/pxelinux.cfg/coreos-node-slave` - -```conf -default coreos -prompt 1 -timeout 15 - -display boot.msg - -label coreos - menu default - kernel images/coreos/coreos_production_pxe.vmlinuz - append initrd=images/coreos/coreos_production_pxe_image.cpio.gz cloud-config-url=http:///coreos/pxe-cloud-config-slave.yml console=tty0 console=ttyS0 coreos.autologin=tty1 coreos.autologin=ttyS0 -``` - -为 _master_ 节点也创建一个： `vi /tftpboot/pxelinux.cfg/coreos-node-master` - -```conf -default coreos -prompt 1 -timeout 15 - -display boot.msg - -label coreos - menu default - kernel images/coreos/coreos_production_pxe.vmlinuz - append initrd=images/coreos/coreos_production_pxe_image.cpio.gz cloud-config-url=http:///coreos/pxe-cloud-config-master.yml console=tty0 console=ttyS0 coreos.autologin=tty1 coreos.autologin=ttyS0 -``` - -## 指定pxelinux目标 - -在上一步骤中我们已经设置了master和slave节点的目标, 我们需要将特定的主机配置为这些目标。为实现这一点，我们可以通过将指定的MAC地址配置到指定的pxelinux.cfg文件的方法来解决。 - -参照本文开始时的MAC地址列表，可以做出下文中的修改。更多细节信息请参阅[相关文档](http://www.syslinux.org/wiki/index.php/PXELINUX). - -```shell -cd /tftpboot/pxelinux.cfg -ln -s coreos-node-master 01-d0-00-67-13-0d-00 -ln -s coreos-node-slave 01-d0-00-67-13-0d-01 -ln -s coreos-node-slave 01-d0-00-67-13-0d-02 -``` - -重启这些服务器令这些镜像PXE化并准备开始运行容器！ - -## 创建测试pod - -现在，Kubernetes已经成功部署在CoreOS上了，我们可以创建一些pod来测试部署。 - -请参考[一个简单的nginx样例部署](/docs/user-guide/simple-nginx)来测试集群环境。 - -更多完整的应用程序示例，请参阅[示例目录](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/)中的各种例子。 - -## 一些用于调试的帮助命令 - -列出etcd中的所有关键字： - -```shell -etcdctl ls --recursive -``` - -列出所有fleet集群中的机器： - -```shell -fleetctl list-machines -``` - -查阅master节点上各种Kubernetes服务的系统状态： - -```shell -systemctl status kube-apiserver -systemctl status kube-controller-manager -systemctl status kube-scheduler -systemctl status kube-register -``` - -查阅集群节点上各种服务的系统状态： - -```shell -systemctl status kube-kubelet -systemctl status docker.service -``` - -列举Kubernetes环境中的各种对象： - -```shell -kubectl get pods -kubectl get nodes -``` - -结束Kubernetes中的所有pod： - -```shell -for i in `kubectl get pods | awk '{print $1}'`; do kubectl delete pod $i; done -``` - -## 支持级别 - - -IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level --------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -Bare-metal (Offline) | CoreOS | CoreOS | flannel | [docs](/docs/getting-started-guides/coreos/bare_metal_offline) | | Community ([@jeffbean](https://github.com/jeffbean)) - -有关所有解决方案的支持级别信息，请参阅[解决方案列表](/docs/getting-started-guides/#table-of-solutions)。 diff --git a/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml b/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml index 55af44ac1b97b..07bebfb47b5d0 100644 --- a/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml +++ b/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml @@ -10,14 +10,14 @@ spec: args: - while true; do echo -en '\n'; - if [[ -e /etc/cpu_limit ]]; then - echo -en '\n'; cat /etc/cpu_limit; fi; + if [[ -e /etc/podinfo/cpu_limit ]]; then + echo -en '\n'; cat /etc/podinfo/cpu_limit; fi; if [[ -e /etc/cpu_request ]]; then - echo -en '\n'; cat /etc/cpu_request; fi; + echo -en '\n'; cat /etc/podinfo/cpu_request; fi; if [[ -e /etc/mem_limit ]]; then - echo -en '\n'; cat /etc/mem_limit; fi; + echo -en '\n'; cat /etc/podinfo/mem_limit; fi; if [[ -e /etc/mem_request ]]; then - echo -en '\n'; cat /etc/mem_request; fi; + echo -en '\n'; cat /etc/podinfo/mem_request; fi; sleep 5; done; resources: @@ -29,7 +29,7 @@ spec: cpu: "250m" volumeMounts: - name: podinfo - mountPath: /etc + mountPath: /etc/podinfo readOnly: false volumes: - name: podinfo diff --git a/cn/docs/tasks/inject-data-application/dapi-volume.yaml b/cn/docs/tasks/inject-data-application/dapi-volume.yaml index 864c99d11e01f..e7515afba5829 100644 --- a/cn/docs/tasks/inject-data-application/dapi-volume.yaml +++ b/cn/docs/tasks/inject-data-application/dapi-volume.yaml @@ -16,15 +16,15 @@ spec: command: ["sh", "-c"] args: - while true; do - if [[ -e /etc/labels ]]; then - echo -en '\n\n'; cat /etc/labels; fi; - if [[ -e /etc/annotations ]]; then - echo -en '\n\n'; cat /etc/annotations; fi; + if [[ -e /etc/podinfo/labels ]]; then + echo -en '\n\n'; cat /etc/podinfo/labels; fi; + if [[ -e /etc/podinfo/annotations ]]; then + echo -en '\n\n'; cat /etc/podinfo/annotations; fi; sleep 5; done; volumeMounts: - name: podinfo - mountPath: /etc + mountPath: /etc/podinfo readOnly: false volumes: - name: podinfo diff --git a/cn/docs/tutorials/kubernetes-basics/index.html b/cn/docs/tutorials/kubernetes-basics/index.html index eac5a29ad5219..c65fbabf5ae7c 100644 --- a/cn/docs/tutorials/kubernetes-basics/index.html +++ b/cn/docs/tutorials/kubernetes-basics/index.html @@ -38,7 +38,7 @@

Kubernetes 可以为您做些什么?

-
+

Kubernetes 基础模块

diff --git a/cn/docs/tutorials/stateful-application/cassandra.md b/cn/docs/tutorials/stateful-application/cassandra.md index 2489860d18056..91bd0d18333b1 100644 --- a/cn/docs/tutorials/stateful-application/cassandra.md +++ b/cn/docs/tutorials/stateful-application/cassandra.md @@ -728,7 +728,7 @@ spec: name: jmx - containerPort: 9042 name: cql - # If you need it it is going away in C* 4.0 + # If you need it, it will go away in C* 4.0. #- containerPort: 9160 # name: thrift resources: diff --git a/cn/docs/user-guide/nginx-secure-app.yaml b/cn/docs/user-guide/nginx-secure-app.yaml index 9e4a16791e065..ec180a18df3d3 100644 --- a/cn/docs/user-guide/nginx-secure-app.yaml +++ b/cn/docs/user-guide/nginx-secure-app.yaml @@ -17,11 +17,14 @@ spec: selector: run: my-nginx --- -apiVersion: apps/v1beta1 +apiVersion: apps/v1 kind: Deployment metadata: name: my-nginx spec: + selector: + matchLabels: + run: my-nginx replicas: 1 template: metadata: diff --git a/cn/docs/user-guide/run-my-nginx.yaml b/cn/docs/user-guide/run-my-nginx.yaml index b3d8e336cdec0..76a879f5c4c24 100644 --- a/cn/docs/user-guide/run-my-nginx.yaml +++ b/cn/docs/user-guide/run-my-nginx.yaml @@ -1,8 +1,11 @@ -apiVersion: apps/v1beta1 +apiVersion: apps/v1 kind: Deployment metadata: name: my-nginx spec: + selector: + matchLabels: + run: my-nginx replicas: 2 template: metadata: diff --git a/community/index.html b/community/index.html index 43225786a1fe7..8e901a2374bc8 100644 --- a/community/index.html +++ b/community/index.html @@ -14,9 +14,9 @@

Community

Ensuring Kubernetes works well everywhere and for everyone.

Connect with the Kubernetes community on our Slack channel or join the Kubernetes-dev Google group. A weekly - community meeting takes place via video conference to discuss the state of affairs, - get a calendar invite - to participate.

+ community meeting takes place via video conference to discuss the state of affairs, see + these instructions for information + on how to participate.

You can also join Kubernetes all around the world through our Kubernetes Meetup Community and the Kubernetes Cloud Native Meetup Community.

diff --git a/css/style_amadeus.css b/css/style_amadeus.css new file mode 100644 index 0000000000000..7a91c4f692fee --- /dev/null +++ b/css/style_amadeus.css @@ -0,0 +1,469 @@ +#caseStudyTitle { + margin-top: 1em !important; + font-family:"Roboto", sans-serif; +} + +p { + font-family:"Roboto", sans-serif; + padding:5%; +} + +.header_logo { + + width:23%; + margin-bottom:-0.6%; + margin-left:10px; +} + +a { + text-decoration:none; + color:#3366ff; +} + +body { + margin:0; + +} + +h1 { + font-family:"Roboto", sans-serif; + font-weight:bold; + letter-spacing:0.025em; + font-size:42px; + padding-bottom:0px; +} + +.subhead { + font-size:26px; + font-weight:100; + line-height:40px; + padding-bottom:1%; + padding-top:0.5%; + +} + +.banner1 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:12%; + padding-bottom:0.5%; + padding-left:10%; + font-size:32px; + background: url('/images/CaseStudy_amadeus_banner1.jpg'); + background-size:100% auto; + background-repeat:no-repeat; +} + +.banner2 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + width:100%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background-size:100% auto; + background-color:#666666; + background-repeat:repeat; + +} + +.banner3 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-left:5%; + padding-right:5%; + padding-top:4%; + padding-bottom:4%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background: url('/images/CaseStudy_amadeus_banner3.jpg'); + background-size:100% auto; +} + +.banner4 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:5%; + padding-bottom:5%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background: url('/images/CaseStudy_amadeus_banner4.jpg'); + background-size:100% auto; +} + +.banner5 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:3%; + padding-bottom:3%; + font-size:24px; + letter-spacing:0.03em; + line-height:35px; + float:left; + background-size:100% auto; + background-color:#666666; + background-repeat:no-repeat; +} + +.banner2text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:70%; + padding-left:15%; + float:left; + text-align:center; +} + +.banner3text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:75%; + padding-left:13%; + text-align:center; +} + +.banner4text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:65%; + padding-left:17%; + text-align:center; +} + +.banner5text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:68%; + padding-left:16%; + float:left; + text-align:center; +} + + +h2 { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:24px; + line-height:34px; + color:#3366ff; +} + +.quote { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:22px; + line-height:32px; + color:#3366ff; +} + +.details { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:18px; + color:#3366ff; + letter-spacing:0.03em; + padding-bottom:1.5%; + padding-top:2%; + padding-left:10%; +} + + +hr { + border-bottom:0px solid; + width:100%; + opacity:0.5; + color:#aaaaaa; + height:1px; +} + +.col1 { + width: 42%; + padding-right:8%; + float:left; + font-family:"Roboto", sans-serif; + font-weight:100; + color:#606060; + line-height:20px; + letter-spacing:0.03em; + font-size:14px; + +} + +.col2 { + width: 45%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:20px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; + +} + +.fullcol { + width:77%; + margin-left:11%; + margin-right:10%; + margin-top:4%; + margin-bottom:4%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:22px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; +} + +.cols { + width:80%; + margin-left:10%; + margin-top:1%; + margin-bottom:4%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + +} + +h4 { + font-family:"Roboto", sans-serif; + font-weight:400; + letter-spacing:0.9; + font-size:20px; + padding-bottom:0px; +} + + +@media screen and (max-width: 910px){ + +h1 { + font-family:"Roboto", sans-serif; + font-weight:bold; + line-height:36px; + letter-spacing:0.03em; + font-size:30px !important; + padding-bottom:0px; + width:80%; +} + +.header_logo { + width:35%; + margin-bottom:-.5%; + magin-left:10px; +} + +.subhead { + font-size:18px; + font-weight:100; + line-height:27px; +} + +.details { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:16px; + color:#3366ff; + letter-spacing:0.03em; + padding-bottom:2%; + line-height:28px; + padding-top:4%; + padding-left:10%; +} + +.logo { + width:8%; +} + +.col1 { + width: 95%; + padding-right:8%; + float:left; + font-family:"Roboto", sans-serif; + font-weight:300; + color:#606060; + line-height:20px; + letter-spacing:0.03em; + font-size:14px; +} + +.col2 { + width: 95%; + padding-top:2%; + padding-bottom:5%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:20px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; +} + +.banner1 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:15%; + padding-bottom:2%; + padding-left:10%; + font-size:18px; + background: url('/images/CaseStudy_amadeus_banner1.jpg'); + background-size:100% auto; +} + +.banner2 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:18px; + letter-spacing:0.03em; + line-height:24px; + width:100%; + float:left; + background:none; + background-color:#666666; +} + +.banner3 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:5%; + padding-bottom:5%; + font-size:16px; + letter-spacing:0.03em; + line-height:23px; + width:90%; + float:left; + background: url('/images/CaseStudy_amadeus_banner3.jpg'); +} + +.banner4 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:18px; + letter-spacing:0.03em; + line-height:24px; + width:100%; + float:left; + background: url('/images/CaseStudy_amadeus_banner4.jpg'); +} + +.banner5 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:16px; + letter-spacing:0.03em; + line-height:23px; + width:100%; + float:left; + background:none; + background-color:#666666; +} + +.banner2text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-bottom:1%; + padding-top:1%; + float:left; + text-align:center; + color:#ffffff; +} + +.banner3text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:5%; + padding-bottom:5%; + text-align:center; +} + +.banner4text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:3%; + padding-bottom:3%; + text-align:center; +} + +.banner5text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:3%; + padding-bottom:3%; + text-align:center; +} + +.fullcol { + margin-top:6%; + margin-bottom:8%; +} + +h2 { + line-height:26px; + font-size:18px; +} + +.quote { + font-size:18px; + line-height:24px; +} + +.logo { + width:35%; +} + +@media screen and (max-width: 580px){ + + .header_logo { + width:60%; + margin-bottom:1%; + margin-left:0%; + margin-top:2%; + + } + + .banner1 { + background: url('/images/CaseStudy_amadeus_banner_mobile.jpg'); + + +} diff --git a/css/style_haufegroup.css b/css/style_haufegroup.css new file mode 100644 index 0000000000000..1a8dc502fd68d --- /dev/null +++ b/css/style_haufegroup.css @@ -0,0 +1,468 @@ +#caseStudyTitle { + margin-top: 1em !important; + font-family:"Roboto", sans-serif; +} + +p { + font-family:"Roboto", sans-serif; + padding:5%; +} + +.header_logo { + + width:32%; + margin-bottom:-1%; + margin-left:10px; +} + +a { + text-decoration:none; + color:#3366ff; +} + +body { + margin:0; + +} + +h1 { + font-family:"Roboto", sans-serif; + font-weight:bold; + letter-spacing:0.025em; + font-size:42px; + padding-bottom:0px; +} + +.subhead { + font-size:26px; + font-weight:100; + line-height:40px; + padding-bottom:1%; + padding-top:0.5%; + +} + +.banner1 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:12%; + padding-bottom:0.5%; + padding-left:10%; + font-size:32px; + background: url('/images/CaseStudy_haufegroup_banner1.jpg'); + background-size:100% auto; + background-repeat:no-repeat; +} + +.banner2 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + width:100%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background-size:100% auto; + background-color:#666666; + background-repeat:repeat; + +} + +.banner3 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-left:5%; + padding-right:5%; + padding-top:4%; + padding-bottom:4%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background: url('/images/CaseStudy_haufegroup_banner3.jpg'); + background-size:100% auto; +} + +.banner4 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:5%; + padding-bottom:5%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background: url('/images/CaseStudy_haufegroup_banner4.jpg'); + background-size:100% auto; +} + +.banner5 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:3%; + padding-bottom:3%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background-size:100% auto; + background-color:#666666; + background-repeat:no-repeat; +} + +.banner2text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:60%; + padding-left:20%; + float:left; + text-align:center; +} + +.banner3text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:70%; + padding-left:15%; + text-align:center; +} + +.banner4text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:65%; + padding-left:17%; + text-align:center; +} + +.banner5text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:68%; + padding-left:16%; + float:left; + text-align:center; +} + + +h2 { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:24px; + line-height:34px; + color:#3366ff; +} + +.quote { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:22px; + line-height:32px; + color:#3366ff; +} + +.details { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:18px; + color:#3366ff; + letter-spacing:0.03em; + padding-bottom:1.5%; + padding-top:2%; + padding-left:10%; +} + + +hr { + border-bottom:0px solid; + width:100%; + opacity:0.5; + color:#aaaaaa; + height:1px; +} + +.col1 { + width: 43%; + padding-right:8%; + float:left; + font-family:"Roboto", sans-serif; + font-weight:100; + color:#606060; + line-height:20px; + letter-spacing:0.03em; + font-size:14px; + +} + +.col2 { + width: 41%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:20px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; + +} + +.fullcol { + width:77%; + margin-left:11%; + margin-right:10%; + margin-top:4%; + margin-bottom:4%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:22px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; +} + +.cols { + width:80%; + margin-left:10%; + margin-top:1%; + margin-bottom:4%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + +} + +h4 { + font-family:"Roboto", sans-serif; + font-weight:400; + letter-spacing:0.9; + font-size:20px; + padding-bottom:0px; +} + + +@media screen and (max-width: 910px){ + +h1 { + font-family:"Roboto", sans-serif; + font-weight:bold; + line-height:36px; + letter-spacing:0.03em; + font-size:30px !important; + padding-bottom:0px; + width:80%; +} + +.header_logo { + width:35%; + margin-bottom:-.5%; + magin-left:10px; +} + +.subhead { + font-size:18px; + font-weight:100; + line-height:27px; +} + +.details { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:16px; + color:#3366ff; + letter-spacing:0.03em; + padding-bottom:2%; + line-height:28px; + padding-top:4%; + padding-left:10%; +} + +.logo { + width:8%; +} + +.col1 { + width: 95%; + padding-right:8%; + float:left; + font-family:"Roboto", sans-serif; + font-weight:300; + color:#606060; + line-height:20px; + letter-spacing:0.03em; + font-size:14px; +} + +.col2 { + width: 95%; + padding-top:2%; + padding-bottom:5%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:20px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; +} + +.banner1 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:15%; + padding-bottom:2%; + padding-left:10%; + font-size:18px; + background: url('/images/CaseStudy_haufegroup_banner1.jpg'); + background-size:100% auto; +} + +.banner2 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:18px; + letter-spacing:0.03em; + line-height:24px; + width:100%; + float:left; + background:none; + background-color:#666666; +} + +.banner3 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:5%; + padding-bottom:5%; + font-size:16px; + letter-spacing:0.03em; + line-height:23px; + width:90%; + float:left; + background: url('/images/CaseStudy_haufegroup_banner3.jpg'); +} + +.banner4 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:18px; + letter-spacing:0.03em; + line-height:24px; + width:100%; + float:left; + background: url('/images/CaseStudy_haufegroup_banner4.jpg'); +} + +.banner5 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:16px; + letter-spacing:0.03em; + line-height:23px; + width:100%; + float:left; + background:none; + background-color:#666666; +} + +.banner2text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-bottom:1%; + padding-top:1%; + float:left; + text-align:center; + color:#ffffff; +} + +.banner3text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:5%; + padding-bottom:5%; + text-align:center; +} + +.banner4text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:3%; + padding-bottom:3%; + text-align:center; +} + +.banner5text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:3%; + padding-bottom:3%; + text-align:center; +} + +.fullcol { + margin-top:6%; + margin-bottom:8%; +} + +h2 { + line-height:26px; + font-size:18px; +} + +.quote { + font-size:18px; + line-height:24px; +} + +.logo { + width:35%; +} + +@media screen and (max-width: 580px){ + + .header_logo { + width:60%; + margin-bottom:1%; + margin-top:2%; + + } + + .banner1 { + background: url('/images/CaseStudy_haufegroup_banner1.jpg'); + + +} diff --git a/css/style_huawei.css b/css/style_huawei.css new file mode 100644 index 0000000000000..a1c86aec4174a --- /dev/null +++ b/css/style_huawei.css @@ -0,0 +1,468 @@ +#caseStudyTitle { + margin-top: 1em !important; + font-family:"Roboto", sans-serif; +} + +p { + font-family:"Roboto", sans-serif; + padding:5%; +} + +.header_logo { + + width:10%; + margin-bottom:-0.6%; + margin-left:10px; +} + +a { + text-decoration:none; + color:#3366ff; +} + +body { + margin:0; + +} + +h1 { + font-family:"Roboto", sans-serif; + font-weight:bold; + letter-spacing:0.025em; + font-size:42px; + padding-bottom:0px; +} + +.subhead { + font-size:26px; + font-weight:100; + line-height:40px; + padding-bottom:1%; + padding-top:0.5%; + +} + +.banner1 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:12%; + padding-bottom:0.5%; + padding-left:10%; + font-size:32px; + background: url('/images/CaseStudy_huawei_banner1.jpg'); + background-size:100% auto; + background-repeat:no-repeat; +} + +.banner2 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + width:100%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background-size:100% auto; + background-color:#666666; + background-repeat:repeat; + +} + +.banner3 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-left:5%; + padding-right:5%; + padding-top:4%; + padding-bottom:4%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background: url('/images/CaseStudy_huawei_banner3.jpg'); + background-size:100% auto; +} + +.banner4 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:5%; + padding-bottom:5%; + font-size:24px; + letter-spacing:0.03em; + line-height:34px; + float:left; + background: url('/images/CaseStudy_huawei_banner4.jpg'); + background-size:100% auto; +} + +.banner5 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:3%; + padding-bottom:3%; + font-size:24px; + letter-spacing:0.03em; + line-height:35px; + float:left; + background-size:100% auto; + background-color:#666666; + background-repeat:no-repeat; +} + +.banner2text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:65%; + padding-left:18%; + float:left; + text-align:center; +} + +.banner3text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:75%; + padding-left:13%; + text-align:center; +} + +.banner4text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:65%; + padding-left:17%; + text-align:center; +} + +.banner5text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:68%; + padding-left:16%; + float:left; + text-align:center; +} + + +h2 { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:24px; + line-height:34px; + color:#3366ff; +} + +.quote { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:22px; + line-height:32px; + color:#3366ff; +} + +.details { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:18px; + color:#3366ff; + letter-spacing:0.03em; + padding-bottom:1.5%; + padding-top:2%; + padding-left:10%; +} + + +hr { + border-bottom:0px solid; + width:100%; + opacity:0.5; + color:#aaaaaa; + height:1px; +} + +.col1 { + width: 42%; + padding-right:8%; + float:left; + font-family:"Roboto", sans-serif; + font-weight:100; + color:#606060; + line-height:20px; + letter-spacing:0.03em; + font-size:14px; + +} + +.col2 { + width: 45%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:20px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; + +} + +.fullcol { + width:77%; + margin-left:11%; + margin-right:10%; + margin-top:4%; + margin-bottom:4%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:22px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; +} + +.cols { + width:80%; + margin-left:10%; + margin-top:1%; + margin-bottom:4%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + +} + +h4 { + font-family:"Roboto", sans-serif; + font-weight:400; + letter-spacing:0.9; + font-size:20px; + padding-bottom:0px; +} + + +@media screen and (max-width: 910px){ + +h1 { + font-family:"Roboto", sans-serif; + font-weight:bold; + line-height:36px; + letter-spacing:0.03em; + font-size:30px !important; + padding-bottom:0px; + width:80%; +} + +.header_logo { + width:35%; + margin-bottom:-.5%; + magin-left:10px; +} + +.subhead { + font-size:18px; + font-weight:100; + line-height:27px; +} + +.details { + font-family:"Roboto", sans-serif; + font-weight:300; + font-size:16px; + color:#3366ff; + letter-spacing:0.03em; + padding-bottom:2%; + line-height:28px; + padding-top:4%; + padding-left:10%; +} + +.logo { + width:8%; +} + +.col1 { + width: 95%; + padding-right:8%; + float:left; + font-family:"Roboto", sans-serif; + font-weight:300; + color:#606060; + line-height:20px; + letter-spacing:0.03em; + font-size:14px; +} + +.col2 { + width: 95%; + padding-top:2%; + padding-bottom:5%; + font-family:"Roboto", sans-serif; + font-weight:300; + float:left; + line-height:20px; + color:#606060; + letter-spacing:0.03em; + font-size:14px; +} + +.banner1 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:15%; + padding-bottom:2%; + padding-left:10%; + font-size:18px; + background: url('/images/CaseStudy_huawei_banner1.jpg'); + background-size:100% auto; +} + +.banner2 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:18px; + letter-spacing:0.03em; + line-height:24px; + width:100%; + float:left; + background:none; + background-color:#666666; +} + +.banner3 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:5%; + padding-bottom:5%; + font-size:16px; + letter-spacing:0.03em; + line-height:23px; + width:90%; + float:left; + background: url('/images/CaseStudy_huawei_banner3.jpg'); +} + +.banner4 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:18px; + letter-spacing:0.03em; + line-height:24px; + width:100%; + float:left; + background: url('/images/CaseStudy_huawei_banner4.jpg'); +} + +.banner5 { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + padding-top:4%; + padding-bottom:4%; + font-size:16px; + letter-spacing:0.03em; + line-height:23px; + width:100%; + float:left; + background:none; + background-color:#666666; +} + +.banner2text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-bottom:1%; + padding-top:1%; + float:left; + text-align:center; + color:#ffffff; +} + +.banner3text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:5%; + padding-bottom:5%; + text-align:center; +} + +.banner4text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:3%; + padding-bottom:3%; + text-align:center; +} + +.banner5text { + font-family:"Roboto", sans-serif; + font-weight:300; + color:#ffffff; + width:90%; + padding-left:5%; + padding-top:3%; + padding-bottom:3%; + text-align:center; +} + +.fullcol { + margin-top:6%; + margin-bottom:8%; +} + +h2 { + line-height:26px; + font-size:18px; +} + +.quote { + font-size:18px; + line-height:24px; +} + +.logo { + width:35%; +} + +@media screen and (max-width: 580px){ + + .header_logo { + width:60%; + margin-bottom:1%; + margin-top:2%; + + } + + .banner1 { + background: url('/images/CaseStudy_blablacar_banner1_mobile.jpg'); + + +} diff --git a/css/style_user_journeys.css b/css/style_user_journeys.css new file mode 100644 index 0000000000000..a68d77e5cf8bd --- /dev/null +++ b/css/style_user_journeys.css @@ -0,0 +1,925 @@ +body { + + margin:0 auto; + +} + +.infobarWrapper a { + color:#303030; +} + +#encyclopedia { +padding: 0px !important; + +} + + +span .editthispage { +display: -webkit-inline-box !important; + +} + +.editthispage { +display: -webkit-inline-box !important; +} + +h1 { + +padding-top: 3% !important; +padding-bottom: 1.5% !important; +padding-left: 3% !important; +padding-right: 3% !important; +text-align: center !important; +font-size: 22pt !important; +font-weight:normal; +color:#303030; + +} + +.container { +width:80%; + +} + +.issue-button-container { + width: 75%; + margin-left: 15%; + padding-left: 1.5%; + padding-bottom: 2%; +} + +.anchor { + display: block; + position: relative; + top: -50px; + visibility: hidden; +} + +.pages a { + font-family: 'roboto'; + font-size:11pt; + text-decoration:none !important; + letter-spacing:0.03em; + color:#606060; +} + +.pages a:hover{ + color:black; +} + +.docstitle a{ + font-family: 'roboto'; + font-size:16pt; + margin-bottom:50px !important; + color:#3371e3 !important; + text-decoration:none !important; + +} + +.docstitle { + margin-bottom:10px !important; +} + +.emphasize-box { + background-color: #dde1e4; + margin: 2% 10%; + padding-top: 20px; + padding-bottom: 5px; +} + +.emphasize-box li { + font-size: 14px !important; +} + +.browsedocs { + font-family: 'roboto' !important; + width:75%; + margin-top:2%; + margin-bottom:5%; + margin-left:15%; + line-height:2em; +} + +.browsecolumn { + float:left; + width: 33%; + +} + +.browsesection { + float:left; + display:block; + width:100%; + margin:2%; +} + +.pages { + width:100%; + color:#606060 !important; +} + + +.browseheader { + font-family: 'roboto'; + text-align:center; + padding:1%; + color:white !important; + font-weight:100; + font-size:18px; + text-transform:uppercase; + font-weight:400; + background-color:#303030; + letter-spacing:0.08em; + background-repeat:repeat; + background-size:contain; + background-position:center; +} +.browseheader a{ + + color:white !important; + +} + + + +.topheader { + background-color: white !important; + color:#303030; + font-family: 'roboto'; + text-align:center; + padding:3%; + font-weight:300; + font-size:24pt; + letter-spacing:0.06em; + +} + +.docssectionheaders { + background-color: #eeeeee !important; + color:#3371e3; + font-family: 'roboto'; + text-align:center; + padding: 3%; + margin: 6% 0% 2% 0%; + font-weight:300; + font-size:18pt; + letter-spacing:0.06em; +} + +.docscols { +width:100%; +float:left; +} + +.section1 { +width:100%; +float:left; +} + + +.docscol1 { +background-color:#eeeeee; +padding:2%; +margin-right:2%; +width:28% !important; +display:inline-block; +float:left; + +} + +.docscol2 { +background-color:#ffffff; +border:1px solid #aaaaaa; +padding:2%; +width:27% !important; +float:left; +margin-right:2%; +display:inline-block; + +} + +.docscol3 { +background-color:#ffffff; +padding:1.5%; +width:27% !important; +display:inline-block; +float:right; +border:1px solid blue; + +} + +.docscoltitle { +float:left; +padding-top:%; +margin-right:2%; +padding-bottom:3%; +font-size:16pt; +line-height:20pt; +font-weight:400; +color:#3371e3; + +} + +.docsfullcol1 { + + width:95%; + padding:2%; + margin:3%; +} + +.docsfullcol2 { + + width:95%; + padding:2%; + background-color:#eeeeee; + margin:3%; +} + +.docsfullcol3 { +background-color:#ffffff; +padding:2%; +width:95%; +display:inline-block; + +border:1px solid blue; +margin:3%; + +} + +.docsfullcol1icon { + width:5%; + padding:2%; +} + +.docstitle2 { +padding:0%; +padding-bottom:3%; +font-size:16pt; +text-align:center; +font-weight:400; +padding-top:2%; +color:#3371e3; +} + +.docsButton { + + background-color:#3371e3; + color:white; + border: 2px solid #ffffff; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #ffffff; + padding:1%; + text-decoration:none; + margin:%; + } + + + +} + +.material-icons { + +font-size:50pt !important; +color:#3371e3; + +} + +.paths { + padding:1%; + background-color:#3371e3; + text-align:center; + +} + +.display-bar { +padding:1%; +background-color:#303030; +text-align:center; +font-size:18px; +font-family: 'roboto'; +text-transform:uppercase; +text-align:center; +letter-spacing:0.1em; +color:#ffffff; + +} + +.cards { +padding:0% 3% 3%; +width:80%; + margin-left:10%; +background-color:#ffffff; +text-align:center; +font-family: 'roboto'; +text-transform:uppercase; +text-align:center; +letter-spacing:0.1em; +} + +.cards > div { + display: none; +} + +button { + + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #ffffff; + padding:1%; + margin:1%; + color:#ffffff; + font-family: 'roboto'; + text-transform:uppercase; + text-align:center; + letter-spacing:0.1em; + display: inline-block; + +} + + +.navButton { + white-space:nowrap; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #ffffff; + padding:1%; + margin:1%; + color:#3371e3; + background-color:white; + font-family: 'roboto'; + text-transform:uppercase; + text-align:center; + letter-spacing:0.1em; + display: inline-block; + cursor: pointer; + +} + +.navButton:active { + + background-color:#3371e3; + color:white; + border: 2px solid #ffffff; +} + +.navButton:visited { + + background-color:#3371e3; + color:white; + border: 2px solid #ffffff; +} + +.navButton:focus { + + background-color:#3371e3 !important
; + color:white; + border: 2px solid #ffffff; +} + + +.navButton:hover, .keepShow { + + background-color:#3371e3; + color:white; + border: 2px solid #ffffff; +} + + + +.buttons { + background-color:#3371e3; + white-space:nowrap; + cursor:pointer; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #ffffff; + padding:2%; + margin:1%; + color:#ffffff; + font-family: 'roboto'; + text-transform:uppercase; + text-align:center; + letter-spacing:0.1em; + display: inline-block; + width:250px; + vertical-align:middle; + line-height:1.3em; + + +} + + +.buttonoption1 { + background-color:#3371e3; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #ffffff; + padding:2%; + margin:1%; + color:#ffffff; + font-family: 'roboto'; + text-transform:uppercase; + text-align:center; + letter-spacing:0.1em; + display: inline-block; + width:250px; + vertical-align:middle; + + +} + + + +.buttons:active .active{ + + background-color:white; + color:#3371e3; + border: 2px solid #3371e3; +} + +.buttons:hover { + + background-color:white; + color:#3371e3; + border: 2px solid #3371e3; + cursor: pointer; +} + +.buttons:target { + + background-color:white; + color:#3371e3; + border: 2px solid #3371e3; + +} + +.buttons:visited { + + background-color:white; + color:#3371e3; + border: 2px solid #3371e3; + +} + +.buttons.selected { + background-color:white; + color:#3371e3; + border: 2px solid #3371e3; + +} + +/*.keepShow { + + background-color:white; + color:#3371e3; + border: 2px solid white; + +}*/ + +.level { + background-color:#ffffff; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #303030; + padding:0%; + padding-top:3%; + margin:1%; + margin-top:4%; + color:#303030; + font-family: 'roboto'; + font-weight:100; + text-transform:none; + text-align:center; + letter-spacing:0.1em; + display: inline-block; + width:250px; cursor: pointer; + cursor: pointer; + + +} +.level:hover, .level.selected { + background-color:#dddddd; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #303030; + + cursor: pointer; + +} + + +.tab1text{ + padding:5%; + color:#303030; + font-size:15px; + line-height:22px; + +} + +.tabbottom { + +background-color:#303030; +color:#ffffff;; +font-family:'roboto'; +width:100%; +margin:0px; +font-size:34 !important; + + +} + + +i { + + font-size:44px !important; + text-align:center; + color:#000066; + +} +.infobarWrapper { + visibility: hidden; + margin-bottom:5%; +} +.infobar { + padding:0%; + background-color:#3371e3; + text-align:center; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 2px solid #ffffff; + padding:2%; + font-size:22px; + line-height:30px; + letter-spacing:0.07em; + text-transform:uppercase; + margin:3%; + font-weight:bold; + color:#ffffff; + font-family: 'roboto'; + width:70%; + margin-left:15%; + margin-bottom:3%; + + +} + +.whitebar { + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + background-color:#ffffff; + text-transform:none; + padding:3%; + letter-spacing:0.6pt; + font-size:15px; + z-index:99; + font-weight:400; + line-height:18pt; + color:#606060; + margin:1%; + text-align:left; +} + +.whitebararrow{ + float:right + padding:3%; + font-size:15px; + z-index:99; + font-weight:100; + line-height:18pt; + color:#606060; + margin:1%; + text-align:right; +} + + +.hide { + +float:left; +font-size:16px; +padding-left:2%; +padding-bottom:5%; + + + +} + + + +.fa { + + line-height:0.7em !important; +} + + +.infoicon { +float:left; +padding-bottom:2%; +padding-right:2%; +margin-bottom:10%: +color:#3371e3 !important; +} + +.numberCircle { +display:inline-block; +line-height:0px; + +border-radius:5px; +border:2px solid; +font-weight:300; +font-size:24px; +} + +.numberCircle span { + display:inline-block; + padding-top:50%; padding-bottom:50%; + margin-left:12px; + margin-right:12px; +} + +.docButton { + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; /* future proofing */ + -khtml-border-radius: 5px; /* for old Konqueror browsers */ + border: 1.5px solid #3371e3; + padding:1%; + background-color:#eeeeee; + font-size:13px; + margin:.5%; + color:#3371e3; + font-family: 'roboto'; + text-transform:uppercase; + text-align:center; + letter-spacing:0.1em; + display: inline-block; + +} + +.docButton:hover { + border: 1.5px solid #3371e3; + background-color:#3371e3; + font-size:13px; + color:#eeeeee; + + +} + +.tablebar { + text-align:center; + background-color:#eeeeee; + padding:1.5%; + +} + +.aboutsection { + background-color:white; + font-family: 'roboto'; + font-weight:300 !important; + font-size:14px; + letter-spacing:0.05em; + line-height:22px; + width:70%; + margin-left:15%; + padding-bottom:5%; + +} + +.aboutsection p { + font-size: 16px; + text-align:center; + font-weight:300; + line-height: 1.75em; + letter-spacing: 0.1px; + margin-bottom: 0.75em; +} + +.aboutsection a { + text-decoration: underline; + color:#3371e3; + font-weight:400; +} + +.aboutcolumn { + float:left; + width: 50%; + text-align: center; +} + +.docsection1 { + background-color:white; + font-family: 'roboto'; + padding-top:3%; + padding-left:3%; + padding-right:3%; + font-weight:300 !important; + font-size:14px; + letter-spacing:0.05em; + line-height:22px; + width:65%; + margin-left:17%; + +} + +.cards .docsection1 { + display: block !important; + padding: 3% 3% 1%; + text-transform: none; +} + +#persona-definition { + visibility: hidden; +} + +.about-k8s-content { + width: 100%; + float: right; +} + +.docsection1 a { + text-decoration: underline; +} + +.docsection1 p { + font-size: 16px; + font-weight:300; + line-height: 1.75em; + letter-spacing: 0.1px; + margin-bottom: 0.75em; +} + +.docsection1 li { + margin-bottom: 0.75em; + margin-left: 3em; + font-size: 16px; + font-weight:300; + line-height: 1.75em; + letter-spacing: 0.1px; +} + +.docsection1 ol li { + list-style: decimal; +} + +.docsection1 ul li { + list-style: disc; +} + +.docsection1 code { + font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; + + font-size: 90%; + + padding: 2px 4px; + + color: #c7254e; + border-radius: 4px; + background-color: #f9f2f4; +} + +.intro { + background-color:white; + font-family: 'roboto'; + padding:3%; + font-weight:100; + font-size:14px; + letter-spacing:0.05em; + line-height:22px; + width:100%; + margin-left:10%; + +} +.introtext { + float:right; + background-color:white; + font-family: 'roboto'; + padding:3%; + font-weight:100; + font-size:14px; + letter-spacing:0.05em; + line-height:22px; + width:50%; + margin-left:10%; + +} + +.track { + background-color:#3371e3; + font-family: 'roboto'; + padding:1%; + color:white; + font-weight:500; + text-align:center; + text-transform:uppercase; + font-size:16px; + letter-spacing:0.05em; + line-height:22px; + width:100%; + + +} + + +.sections { + background-color:#303030; + font-family: 'roboto'; + padding:1%; + color:white; + font-weight:500; + text-align:center; + text-transform:uppercase; + font-size:18px; + letter-spacing:0.05em; + line-height:22px; + width:100%; + + +} + + +.quotedocs { + line-height:26pt; + font-size:16pt; + +} + + +table { + width: 100%; + border: 1px solid #ccc; + border-spacing: 0; + margin-top: 30px; + margin-bottom: 30px; +} + +thead, tr:nth-child(even) { + background-color: $light-grey; +} + +thead { + background-color: #555; + color: white; +} + +th, td { + padding: 8px; + text-align: left; + margin: 0; + border: 1px solid #ccc; +} + +th { + font-weight: normal; +} + + + +@media screen and (max-width: 640px) { + +.browsecolumn { +width: 95%; + +} + +.paths { + +margin-top : 10%; +padding:4%; + +} + +.navButton { +padding:2%; + +} + +.buttons { +padding:4%; +} + +.whitebar { +padding:5%; + +} + + +} + diff --git a/docs/admin/OWNERS b/docs/admin/OWNERS index 54a149ead798a..b905dd07578a8 100644 --- a/docs/admin/OWNERS +++ b/docs/admin/OWNERS @@ -1,4 +1,4 @@ -approvers: +reviewers: - derekwaynecarr - mikedanese diff --git a/docs/admin/accessing-the-api.md b/docs/admin/accessing-the-api.md index d3d0268a3e462..b29b547519fcb 100644 --- a/docs/admin/accessing-the-api.md +++ b/docs/admin/accessing-the-api.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - bgrant0607 - erictune - lavalamp diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md index 66d97be994715..4aeacc2c84589 100644 --- a/docs/admin/admission-controllers.md +++ b/docs/admin/admission-controllers.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - lavalamp - davidopp - derekwaynecarr @@ -329,7 +329,7 @@ When the admission controller sets a compute resource request, it does this by * 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 [InitialResouces proposal](https://git.k8s.io/community/contributors/design-proposals/autoscaling/initial-resources.md) for more details. +See the [InitialResources proposal](https://git.k8s.io/community/contributors/design-proposals/autoscaling/initial-resources.md) for more details. ### LimitPodHardAntiAffinity @@ -354,7 +354,7 @@ webhooks are called in serial; each one may modify the object if it desires. This admission controller (as implied by the name) only runs in the mutating phase. If a webhook called by this has side effects (for example, decrementing quota) it -*must* have a reconcilation system, as it is not guaranteed that subsequent +*must* have a reconciliation system, as it is not guaranteed that subsequent webhooks or validating admission controllers will permit the request to finish. If you disable the MutatingAdmissionWebhook, you must also disable the @@ -565,7 +565,7 @@ fails. This admission controller only runs in the validation phase; the webhooks mutate the object, as opposed to the webhooks called by the `MutatingAdmissionWebhook` admission controller. If a webhook called by this has side effects (for example, decrementing quota) it -*must* have a reconcilation system, as it is not guaranteed that subsequent +*must* have a reconciliation system, as it is not guaranteed that subsequent webhooks or other validating admission controllers will permit the request to finish. If you disable the ValidatingAdmissionWebhook, you must also disable the diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md index 7f46f8ce5c755..6d1db7e15c8c0 100644 --- a/docs/admin/authentication.md +++ b/docs/admin/authentication.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - erictune - lavalamp - ericchiang @@ -185,7 +185,7 @@ talk to the API server. Accounts may be explicitly associated with pods using th NOTE: `serviceAccountName` is usually omitted because this is done automatically. ``` -apiVersion: apps/v1beta2 +apiVersion: apps/v1 # this apiVersion is relevant as of Kubernetes 1.9 kind: Deployment metadata: name: nginx-deployment @@ -373,7 +373,7 @@ users: refresh-token: q1bKLFOyUiosTfawzA93TzZIDzH2TNa2SMm0zEiPKTUwME6BkEo6Sql5yUWVBSWpKUGphaWpxSVAfekBOZbBhaEW+VlFUeVRGcluyVF5JT4+haZmPsluFoFu5XkpXk5BXq name: oidc ``` -Once your `id_token` expires, `kubectl` will attempt to refresh your `id_token` using your `refresh_token` and `client_secret` storing the new values for the `refresh_token` and `id_token` in your `kube/.config`. +Once your `id_token` expires, `kubectl` will attempt to refresh your `id_token` using your `refresh_token` and `client_secret` storing the new values for the `refresh_token` and `id_token` in your `.kube/config`. ##### Option 2 - Use the `--token` Option @@ -650,6 +650,7 @@ apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: scopes-impersonator +rules: # Can set "Impersonate-Extra-scopes" header. - apiGroups: ["authentication.k8s.io"] resources: ["userextras/scopes"] @@ -674,7 +675,7 @@ rules: # Can impersonate the groups "developers" and "admins" - apiGroups: [""] resources: ["groups"] -- verbs: ["impersonate"] + verbs: ["impersonate"] resourceNames: ["developers","admins"] # Can impersonate the extras field "scopes" with the values "view" and "development" diff --git a/docs/admin/authorization/abac.md b/docs/admin/authorization/abac.md index d06b5a1ef8d3c..31d47041cf873 100644 --- a/docs/admin/authorization/abac.md +++ b/docs/admin/authorization/abac.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - erictune - lavalamp - deads2k diff --git a/docs/admin/authorization/index.md b/docs/admin/authorization/index.md index 7215332f7a1ef..6cf0e650efd27 100644 --- a/docs/admin/authorization/index.md +++ b/docs/admin/authorization/index.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - erictune - lavalamp - deads2k diff --git a/docs/admin/authorization/node.md b/docs/admin/authorization/node.md index 12a80fc763d69..1bc07d600e0a3 100644 --- a/docs/admin/authorization/node.md +++ b/docs/admin/authorization/node.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - timstclair - deads2k - liggitt diff --git a/docs/admin/authorization/rbac.md b/docs/admin/authorization/rbac.md index 83649663b6cd6..b8cc83e75f43b 100644 --- a/docs/admin/authorization/rbac.md +++ b/docs/admin/authorization/rbac.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - erictune - deads2k - liggitt @@ -138,7 +138,7 @@ subjects: apiGroup: rbac.authorization.k8s.io roleRef: kind: ClusterRole -  name: secret-reader + name: secret-reader apiGroup: rbac.authorization.k8s.io ``` @@ -188,7 +188,7 @@ rules: Notably, if `resourceNames` are set, then the verb must not be list, watch, create, or deletecollection. Because resource names are not present in the URL for create, list, watch, and deletecollection API requests, -those verbs would not be allowed by a rule with resourceNames set, since the resourceNames portion of the +those verbs would not be allowed by a rule with `resourceNames` set, since the `resourceNames` portion of the rule would not match the request. ### Aggregated ClusterRoles @@ -762,7 +762,7 @@ In order from most secure to least secure, the approaches are: If an application does not specify a `serviceAccountName`, it uses the "default" service account. - NOTE: Permissions given to the "default" service account are available to any pod in the namespace that does not specify a `serviceAccountName`. + **NOTE:** Permissions given to the "default" service account are available to any pod in the namespace that does not specify a `serviceAccountName`. For example, grant read-only permission within "my-namespace" to the "default" service account: @@ -776,7 +776,7 @@ In order from most secure to least secure, the approaches are: Many [add-ons](/docs/concepts/cluster-administration/addons/) currently run as the "default" service account in the "kube-system" namespace. To allow those add-ons to run with super-user access, grant cluster-admin permissions to the "default" service account in the "kube-system" namespace. - NOTE: Enabling this means the "kube-system" namespace contains secrets that grant super-user access to the API. + **NOTE:** Enabling this means the "kube-system" namespace contains secrets that grant super-user access to the API. ```shell kubectl create clusterrolebinding add-on-cluster-admin \ @@ -789,7 +789,7 @@ In order from most secure to least secure, the approaches are: If you want all applications in a namespace to have a role, no matter what service account they use, you can grant a role to the service account group for that namespace. - For example, grant read-only permission within "my-namespace" to to all service accounts in that namespace: + For example, grant read-only permission within "my-namespace" to all service accounts in that namespace: ```shell kubectl create rolebinding serviceaccounts-view \ @@ -814,7 +814,7 @@ In order from most secure to least secure, the approaches are: If you don't care about partitioning permissions at all, you can grant super-user access to all service accounts. - WARNING: This allows any user with read access to secrets or the ability to create a pod to access super-user credentials. + **WARNING:** This allows any user with read access to secrets or the ability to create a pod to access super-user credentials. ```shell kubectl create clusterrolebinding serviceaccounts-cluster-admin \ @@ -855,10 +855,11 @@ in the server logs, you can remove the ABAC authorizer. You can replicate a permissive policy using RBAC role bindings. -**WARNING: The following policy allows ALL service accounts to act as cluster administrators. +**WARNING:** The following policy allows **ALL** service accounts to act as cluster administrators. Any application running in a container receives service account credentials automatically, and could perform any action against the API, including viewing secrets and modifying permissions. -This is not a recommended policy.** +This is not a recommended policy. +{: .warning} ``` kubectl create clusterrolebinding permissive-binding \ diff --git a/docs/admin/authorization/webhook.md b/docs/admin/authorization/webhook.md index 390aeef0795a7..99ed39557dcf0 100644 --- a/docs/admin/authorization/webhook.md +++ b/docs/admin/authorization/webhook.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - erictune - lavalamp - deads2k diff --git a/docs/admin/bootstrap-tokens.md b/docs/admin/bootstrap-tokens.md index e84fd2cd6e99f..d998504679ac5 100644 --- a/docs/admin/bootstrap-tokens.md +++ b/docs/admin/bootstrap-tokens.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - jbeda title: Authenticating with Bootstrap Tokens --- @@ -93,8 +93,8 @@ stringData: expiration: 2017-03-10T03:22:11Z # Allowed usages. - usage-bootstrap-authentication: true - usage-bootstrap-signing: true + usage-bootstrap-authentication: "true" + usage-bootstrap-signing: "true" # Extra groups to authenticate the token as. Must start with "system:bootstrappers:" auth-extra-groups: system:bootstrappers:worker,system:bootstrappers:ingress diff --git a/docs/admin/cluster-large.md b/docs/admin/cluster-large.md index 21c50531aa381..19b3e58e95223 100644 --- a/docs/admin/cluster-large.md +++ b/docs/admin/cluster-large.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - davidopp - lavalamp title: Building Large Clusters diff --git a/docs/admin/extensible-admission-controllers.md b/docs/admin/extensible-admission-controllers.md index 78ab5fe398a64..afe5d58308a6e 100644 --- a/docs/admin/extensible-admission-controllers.md +++ b/docs/admin/extensible-admission-controllers.md @@ -1,9 +1,10 @@ --- -approvers: +reviewers: - smarterclayton - lavalamp - whitlockjc - caesarxuchao +- deads2k title: Dynamic Admission Control --- @@ -20,11 +21,169 @@ the following: * They need to be compiled into kube-apiserver. * They are only configurable when the apiserver starts up. -1.7 introduces two alpha features, *Initializers* and *External Admission -Webhooks*, that address these limitations. These features allow admission -controllers to be developed out-of-tree and configured at runtime. +Two features, *Admission Webhooks* (beta in 1.9) and *Initializers* (alpha), +address these limitations. They allow admission controllers to be developed +out-of-tree and configured at runtime. -This page describes how to use Initializers and External Admission Webhooks. +This page describes how to use Admission Webhooks and Initializers. + +## Admission Webhooks + +### What are admission webhooks? + +Admission webhooks are HTTP callbacks that receive admission requests and do +something with them. You can define two types of admission webhooks, +[ValidatingAdmissionWebhooks](/docs/admin/admission-controllers.md#validatingadmissionwebhook-alpha-in-18-beta-in-19) +and +[MutatingAdmissionWebhooks](/docs/admin/admission-controllers.md#mutatingadmissionwebhook-beta-in-19). +With `ValidatingAdmissionWebhooks`, you may reject requests to enforce custom +admission policies. With `MutatingAdmissionWebhooks`, you may change requests to +enforce custom defaults. + +### Experimenting with admission webhooks + +Admission webhooks are essentially part of the cluster control-plane. You should +write and deploy them with great caution. Please read the [user +guides](https://github.com/kubernetes/website/pull/6836/files)(WIP) for +instructions if you intend to write/deploy production-grade admission webhooks. +In the following, we describe how to quickly experiment with admission webhooks. + +### Prerequisites + +* Ensure that the Kubernetes cluster is at least as new as v1.9. + +* Ensure that MutatingAdmissionWebhook and ValidatingAdmissionWebhook + admission controllers are enabled. + [Here](/docs/admin/admission-controllers.md#is-there-a-recommended-set-of-admission-controllers-to-use) + is a recommended set of admission controllers to enable in general. + +* Ensure that the admissionregistration.k8s.io/v1beta1 API is enabled. + +### Write an admission webhook server + +Please refer to the implementation of the [admission webhook +server](https://github.com/kubernetes/kubernetes/blob/v1.10.0-beta.1/test/images/webhook/main.go) +that is validated in a Kubernetes e2e test. The webhook handles the +`admissionReview` requests sent by the apiservers, and sends back its decision +wrapped in `admissionResponse`. + +The example admission webhook server leaves the `ClientAuth` field +[empty](https://github.com/kubernetes/kubernetes/blob/v1.10.0-beta.1/test/images/webhook/config.go#L48-L49), +which defaults to `NoClientCert`. This means that the webhook server does not +authenticate the identity of the clients, supposedly apiservers. If you need +mutual TLS or other ways to authenticate the clients, see +how to [authenticate apiservers](#authenticate-apiservers). + +### Deploy the admission webhook service + +The webhook server in the e2e test is deployed in the Kubernetes cluster, via +the [deployment API](/docs/api-reference/{{page.version}}/#deployment-v1beta1-apps). +The test also creates a [service](/docs/api-reference/{{page.version}}/#service-v1-core) +as the front-end of the webhook server. See +[code](https://github.com/kubernetes/kubernetes/blob/v1.10.0-beta.1/test/e2e/apimachinery/webhook.go#L196). + +You may also deploy your webhooks outside of the cluster. You will need to update +your [webhook client configurations](https://github.com/kubernetes/kubernetes/blob/v1.10.0-beta.1/staging/src/k8s.io/api/admissionregistration/v1beta1/types.go#L218) accordingly. + +### Configure admission webhooks on the fly + +You can dynamically configure what resources are subject to what admission +webhooks via +[ValidatingWebhookConfiguration](https://github.com/kubernetes/kubernetes/blob/v1.10.0-beta.1/staging/src/k8s.io/api/admissionregistration/v1beta1/types.go#L68) +or +[MutatingWebhookConifuration](https://github.com/kubernetes/kubernetes/blob/v1.10.0-beta.1/staging/src/k8s.io/api/admissionregistration/v1beta1/types.go#L98). + +The following is an example `validatingWebhookConfiguration`, a mutating webhook +configuration is similar. + +```yaml +apiVersion: admissionregistration.k8s.io/v1beta1 +kind: ValidatingWebhookConfiguration +metadata: + name: +webhooks: +- name: + rules: + - apiGroups: + - "" + apiVersions: + - v1 + operations: + - CREATE + resources: + - pods + clientConfig: + service: + namespace: + name: + caBundle: +``` + +When an apiserver receives a request that matches one of the `rules`, the +apiserver sends an `admissionReview` request to webhook as specified in the +`clientConfig`. + +After you create the webhook configuration, the system will take a few seconds +to honor the new configuration. + +### Authenticate apiservers + +If your admission webhooks require authentication, you can configure the +apiservers to use basic auth, bearer token, or a cert to authenticate itself to +the webhooks. There are three steps to complete the configuration. + +* When starting the apiserver, specify the location of the admission control + configuration file via the `--admission-control-config-file` flag. + +* In the admission control configuration file, specify where the + MutatingAdmissionWebhook controller and ValidatingAdmissionWebhook controller + should read the credentials. The credentials are stored in kubeConfig files + (yes, the same schema that's used by kubectl), so the field name is + `kubeConfigFile`. Here is an example admission control configuration file: + +```yaml +apiVersion: apiserver.k8s.io/v1alpha1 +kind: AdmissionConfiguration +plugins: +- name: ValidatingAdmissionWebhook + configuration: + apiVersion: apiserver.config.k8s.io/v1alpha1 + kind: WebhookAdmission + kubeConfigFile: +- name: MutatingAdmissionWebhook + configuration: + apiVersion: apiserver.config.k8s.io/v1alpha1 + kind: WebhookAdmission + kubeConfigFile: +``` + +The schema of `admissionConfiguration` is defined +[here](https://github.com/kubernetes/kubernetes/blob/v1.10.0-beta.0/staging/src/k8s.io/apiserver/pkg/apis/apiserver/v1alpha1/types.go#L27). + +* In the kubeConfig file, provide the credentials: + +```yaml +apiVersion: v1 +kind: Config +users: +# DNS name of webhook service, i.e., ..svc, or the URL +# of the webhook server. +- name: 'webhook1.ns1.svc' + user: + client-certificate-data: + client-key-data: +# The `name` supports using * to wildmatch prefixing segments. +- name: '*.webhook-company.org' + user: + password: + username: +# '*' is the default match. +- name: '*' + user: + token: +``` + +Of course you need to set up the webhook server to handle these authentications. ## Initializers @@ -135,153 +294,3 @@ the pods will be stuck in an uninitialized state. Make sure that all expansions of the `` tuple in a `rule` are valid. If they are not, separate them in different `rules`. - -## External Admission Webhooks - -### What are external admission webhooks? - -External admission webhooks are HTTP callbacks that are intended to receive -admission requests and do something with them. What an external admission -webhook does is up to you, but there is an -[interface](https://github.com/kubernetes/kubernetes/blob/v1.7.0-rc.1/pkg/apis/admission/v1alpha1/types.go) -that it must adhere to so that it responds with whether or not the -admission request should be allowed. - -Unlike initializers or the plugin-style admission controllers, external -admission webhooks are not allowed to mutate the admission request in any way. - -Because admission is a high security operation, the external admission webhooks -must support TLS. - -### When to use admission webhooks? - -A simple example use case for an external admission webhook is to do semantic validation -of Kubernetes resources. Suppose that your infrastructure requires that all `Pod` -resources have a common set of labels, and you do not want any `Pod` to be -persisted to Kubernetes if those needs are not met. You could write your -external admission webhook to do this validation and respond accordingly. - -### How are external admission webhooks triggered? - -Whenever a request comes in, the `GenericAdmissionWebhook` admission plugin will -get the list of interested external admission webhooks from -`externalAdmissionHookConfiguration` objects (explained below) and call them in -parallel. If **all** of the external admission webhooks approve the admission -request, the admission chain continues. If **any** of the external admission -webhooks deny the admission request, the admission request will be denied, and -the reason for doing so will be based on the _first_ external admission webhook -denial reason. _This means if there is more than one external admission webhook -that denied the admission request, only the first will be returned to the -user._ If there is an error encountered when calling an external admission -webhook, that request is ignored and will not be used to approve/deny the -admission request. - -**Note:** The admission chain depends solely on the order of the -`--admission-control` option passed to `kube-apiserver`. - -### Enable external admission webhooks - -*External Admission Webhooks* is an alpha feature, so it is disabled by default. -To turn it on, you need to - -* Include "GenericAdmissionWebhook" in the `--admission-control` flag when - starting the apiserver. If you have multiple `kube-apiserver` replicas, all - should have the same flag setting. - -* Enable the dynamic admission controller registration API by adding - `admissionregistration.k8s.io/v1alpha1` to the `--runtime-config` flag passed - to `kube-apiserver`, e.g. - `--runtime-config=admissionregistration.k8s.io/v1alpha1`. Again, all replicas - should have the same flag setting. - -### Write a webhook admission controller - -See [caesarxuchao/example-webhook-admission-controller](https://github.com/caesarxuchao/example-webhook-admission-controller) -for an example webhook admission controller. - -The communication between the webhook admission controller and the apiserver, or -more precisely, the GenericAdmissionWebhook admission controller, needs to be -TLS secured. You need to generate a CA cert and use it to sign the server cert -used by your webhook admission controller. The pem formatted CA cert is supplied -to the apiserver via the dynamic registration API -`externaladmissionhookconfigurations.clientConfig.caBundle`. - -For each request received by the apiserver, the GenericAdmissionWebhook -admission controller sends an -[admissionReview](https://github.com/kubernetes/kubernetes/blob/v1.7.0-rc.1/pkg/apis/admission/v1alpha1/types.go#L27) -to the relevant webhook admission controller. The webhook admission controller -gathers information like `object`, `oldobject`, and `userInfo`, from -`admissionReview.spec`, sends back a response with the body also being the -`admissionReview`, whose `status` field is filled with the admission decision. - -### Deploy the webhook admission controller - -See [caesarxuchao/example-webhook-admission-controller deployment](https://github.com/caesarxuchao/example-webhook-admission-controller/tree/master/deployment) -for an example deployment. - -The webhook admission controller should be deployed via the -[deployment API](/docs/api-reference/{{page.version}}/#deployment-v1beta1-apps). -You also need to create a -[service](/docs/api-reference/{{page.version}}/#service-v1-core) as the -front-end of the deployment. - -### Configure webhook admission controller on the fly - -You can configure what webhook admission controllers are enabled and what -resources are subject to the admission controller via creating -externaladmissionhookconfigurations. - -We suggest that you first deploy the webhook admission controller and make sure -it is working properly before creating the externaladmissionhookconfigurations. -Otherwise, depending whether the webhook is configured as fail open or fail -closed, operations will be unconditionally accepted or rejected. - -The following is an example `externaladmissionhookconfiguration`: - -```yaml -apiVersion: admissionregistration.k8s.io/v1alpha1 -kind: ExternalAdmissionHookConfiguration -metadata: - name: example-config -externalAdmissionHooks: -- name: pod-image.k8s.io - rules: - - apiGroups: - - "" - apiVersions: - - v1 - operations: - - CREATE - resources: - - pods - failurePolicy: Ignore - clientConfig: - caBundle: - service: - name: - namespace: -``` - -For a request received by the apiserver, if the request matches any of the -`rules` of an `externalAdmissionHook`, the `GenericAdmissionWebhook` admission -controller will send an `admissionReview` request to the `externalAdmissionHook` -to ask for admission decision. - -The `rule` is similar to the `rule` in `initializerConfiguration`, with two -differences: - -* The addition of the `operations` field, specifying what operations the webhook - is interested in; - -* The `resources` field accepts subresources in the form or resource/subresource. - -Make sure that all expansions of the `` tuple -in a `rule` are valid. If they are not, separate them to different `rules`. - -You can also specify the `failurePolicy`. In 1.7, the system supports `Ignore` -and `Fail` policies, meaning that upon a communication error with the webhook -admission controller, the `GenericAdmissionWebhook` can admit or reject the -operation based on the configured policy. - -After you create the `externalAdmissionHookConfiguration`, the system will take a few -seconds to honor the new configuration. diff --git a/docs/admin/federation/OWNERS b/docs/admin/federation/OWNERS index ea09d0e999a20..8284752efaf77 100644 --- a/docs/admin/federation/OWNERS +++ b/docs/admin/federation/OWNERS @@ -1,4 +1,4 @@ -approvers: +reviewers: - madhusudancs - mml - nikhiljindal diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md index f52fb5a035f27..0ec3b9b0d15b7 100644 --- a/docs/admin/federation/index.md +++ b/docs/admin/federation/index.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - madhusudancs - mml - nikhiljindal @@ -115,7 +115,7 @@ $ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh push Note: This is going to overwrite the values you might have set for `apiserverRegistry`, `apiserverVersion`, `controllerManagerRegistry` and `controllerManagerVersion` in your `${FEDERATION_OUTPUT_ROOT}/values.yaml` -file. Hence, it is not recommend to customize these values in +file. Hence, it is not recommended to customize these values in `${FEDERATION_OUTPUT_ROOT}/values.yaml` if you are building the images from source. diff --git a/docs/admin/high-availability/OWNERS b/docs/admin/high-availability/OWNERS index 29cfa786c8fbc..5c5ac0bdc24f9 100644 --- a/docs/admin/high-availability/OWNERS +++ b/docs/admin/high-availability/OWNERS @@ -1,4 +1,4 @@ -approvers: +reviewers: - davidopp - lavalamp diff --git a/docs/admin/high-availability/index.md b/docs/admin/high-availability/building.md similarity index 93% rename from docs/admin/high-availability/index.md rename to docs/admin/high-availability/building.md index 3a5d8b1d8393b..fde5b3946939e 100644 --- a/docs/admin/high-availability/index.md +++ b/docs/admin/high-availability/building.md @@ -100,13 +100,13 @@ for `${NODE_IP}` on each machine. Once you copy this into all three nodes, you should have a clustered etcd set up. You can validate on master with ```shell -kubectl exec < pod_name > etcdctl member list +kubectl exec etcdctl member list ``` and ```shell -kubectl exec < pod_name > etcdctl cluster-health +kubectl exec etcdctl cluster-health ``` You can also validate that this is working with `etcdctl set foo bar` on one node, and `etcdctl get foo` @@ -186,7 +186,7 @@ This code is called the "reconciler," because it reconciles the list of endpoints stored in etcd, and the list of endpoints that are actually up and running. -Prior Kubernetes 1.9, the reconciler expects you to provide the +Prior to Kubernetes 1.9, the reconciler expects you to provide the number of endpoints (i.e., the number of apiserver replicas) through a command-line flag (e.g. `--apiserver-count=3`). If more replicas are available, the reconciler trims down the list of endpoints. @@ -209,16 +209,17 @@ continuously try to add itself to the list of endpoints while removing the other ones, causing a lot of extraneous updates in kube-proxy and other components. -Starting with Kubernetes 1.9, a new reconciler implementation is available. -It uses a *lease* that is regularly renewed by each apiserver -replica. When a replica is down, it stops renewing its lease, and -the other replicas notice that the lease expired and remove it -from the list of endpoints. You can switch to the new reconciler -by adding the flag `--endpoint-reconciler-type=lease` when starting -your apiserver replicas. +Starting with Kubernetes 1.9, a new alpha reconciler implementation is +available. It uses a *lease* that is regularly renewed by each apiserver +replica. When a replica is down, it stops renewing its lease, and the other +replicas notice that the lease expired and remove it from the list of +endpoints. You can switch to the new reconciler by adding the flag +`--endpoint-reconciler-type=lease` when starting your apiserver replicas. + +{% include feature-state-alpha.md %} If you want to know more, you can check the following resources: -- [issue kubernetes/kuberenetes#22609](https://github.com/kubernetes/kubernetes/issues/22609), +- [issue kubernetes/kubernetes#22609](https://github.com/kubernetes/kubernetes/issues/22609), which gives additional context - [master/reconcilers/mastercount.go](https://github.com/kubernetes/kubernetes/blob/dd9981d038012c120525c9e6df98b3beb3ef19e1/pkg/master/reconcilers/mastercount.go#L63), the implementation of the master count reconciler diff --git a/docs/admin/kubelet-authentication-authorization.md b/docs/admin/kubelet-authentication-authorization.md index 03ab5fd64b70b..a3bd887317f69 100644 --- a/docs/admin/kubelet-authentication-authorization.md +++ b/docs/admin/kubelet-authentication-authorization.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - liggitt title: Kubelet authentication/authorization --- diff --git a/docs/admin/kubelet-tls-bootstrapping.md b/docs/admin/kubelet-tls-bootstrapping.md index da2b187dff205..f05540ff40e4f 100644 --- a/docs/admin/kubelet-tls-bootstrapping.md +++ b/docs/admin/kubelet-tls-bootstrapping.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - ericchiang - mikedanese - jcbsmpsn diff --git a/docs/admin/limitrange/OWNERS b/docs/admin/limitrange/OWNERS index cca389a7414b3..7179a4a4c3688 100644 --- a/docs/admin/limitrange/OWNERS +++ b/docs/admin/limitrange/OWNERS @@ -1,4 +1,4 @@ -approvers: +reviewers: - derekwaynecarr - janetkuo diff --git a/docs/admin/multiple-schedulers/OWNERS b/docs/admin/multiple-schedulers/OWNERS index 277bb743740c0..981f6a1cd0752 100644 --- a/docs/admin/multiple-schedulers/OWNERS +++ b/docs/admin/multiple-schedulers/OWNERS @@ -1,4 +1,4 @@ -approvers: +reviewers: - davidopp - madhusudancs diff --git a/docs/admin/multiple-schedulers/my-scheduler.yaml b/docs/admin/multiple-schedulers/my-scheduler.yaml deleted file mode 100644 index dde31f119a369..0000000000000 --- a/docs/admin/multiple-schedulers/my-scheduler.yaml +++ /dev/null @@ -1,43 +0,0 @@ -apiVersion: apps/v1beta1 -kind: Deployment -metadata: - labels: - component: scheduler - tier: control-plane - name: my-scheduler - namespace: kube-system -spec: - replicas: 1 - template: - metadata: - labels: - component: scheduler - tier: control-plane - version: second - spec: - containers: - - command: - - /usr/local/bin/kube-scheduler - - --address=0.0.0.0 - - --leader-elect=false - - --scheduler-name=my-scheduler - image: gcr.io/my-gcp-project/my-kube-scheduler:1.0 - livenessProbe: - httpGet: - path: /healthz - port: 10251 - initialDelaySeconds: 15 - name: kube-second-scheduler - readinessProbe: - httpGet: - path: /healthz - port: 10251 - resources: - requests: - cpu: '0.1' - securityContext: - privileged: false - volumeMounts: [] - hostNetwork: false - hostPID: false - volumes: [] diff --git a/docs/admin/multiple-zones.md b/docs/admin/multiple-zones.md index 1900e7e1a4aba..2bb6c818f7af2 100644 --- a/docs/admin/multiple-zones.md +++ b/docs/admin/multiple-zones.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - jlowdermilk - justinsb - quinton-hoole @@ -36,7 +36,7 @@ zone information. Kubernetes will automatically spread the pods in a replication controller or service across nodes in a single-zone cluster (to reduce the impact of -failures.) With multiple-zone clusters, this spreading behaviour is +failures.) With multiple-zone clusters, this spreading behavior is extended across zones (to reduce the impact of zone failures.) (This is achieved via `SelectorSpreadPriority`). This is a best-effort placement, and so if the zones in your cluster are heterogeneous diff --git a/docs/admin/node-conformance.md b/docs/admin/node-conformance.md index 5b6a1297fa396..318c65d68885e 100644 --- a/docs/admin/node-conformance.md +++ b/docs/admin/node-conformance.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - Random-Liu title: Validate Node Setup --- diff --git a/docs/admin/ovs-networking.md b/docs/admin/ovs-networking.md deleted file mode 100644 index a8cda06ecd867..0000000000000 --- a/docs/admin/ovs-networking.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -approvers: -- thockin -title: Kubernetes OpenVSwitch GRE/VxLAN networking ---- - -This document describes how OpenVSwitch is used to setup networking between pods across nodes. -The tunnel type could be GRE or VxLAN. VxLAN is preferable when large scale isolation needs to be performed within the network. - -![OVS Networking](/images/docs/ovs-networking.png) - -The vagrant setup in Kubernetes does the following: - -The docker bridge is replaced with a brctl generated linux bridge (kbr0) with a 256 address space subnet. Basically, a node gets 10.244.x.0/24 subnet and docker is configured to use that bridge instead of the default docker0 bridge. - -Also, an OVS bridge is created(obr0) and added as a port to the kbr0 bridge. All OVS bridges across all nodes are linked with GRE tunnels. So, each node has an outgoing GRE tunnel to all other nodes. It does not need to be a complete mesh really, just meshier the better. STP (spanning tree) mode is enabled in the bridges to prevent loops. - -Routing rules enable any 10.244.0.0/16 target to become reachable via the OVS bridge connected with the tunnels. - - - diff --git a/docs/admin/resourcequota/OWNERS b/docs/admin/resourcequota/OWNERS index 4ada8a6a6c30f..8b5b9c20136d4 100644 --- a/docs/admin/resourcequota/OWNERS +++ b/docs/admin/resourcequota/OWNERS @@ -1,3 +1,3 @@ -approvers: +reviewers: - derekwaynecarr diff --git a/docs/admin/salt.md b/docs/admin/salt.md index 7470601350d6b..e9659e38e4a39 100644 --- a/docs/admin/salt.md +++ b/docs/admin/salt.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - davidopp title: Configuring Kubernetes with Salt --- diff --git a/docs/admin/service-accounts-admin.md b/docs/admin/service-accounts-admin.md index 0f01e29ca197f..a6a93e86b0774 100644 --- a/docs/admin/service-accounts-admin.md +++ b/docs/admin/service-accounts-admin.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - bprashanth - davidopp - lavalamp diff --git a/docs/api-reference/apps/v1beta1/definitions.html b/docs/api-reference/apps/v1beta1/definitions.html deleted file mode 100755 index 7043dfcba4b78..0000000000000 --- a/docs/api-reference/apps/v1beta1/definitions.html +++ /dev/null @@ -1,4099 +0,0 @@ ---- ---- - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1.PhotonPersistentDiskVolumeSource

-
-

Represents a Photon Controller persistent disk resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdID

ID that identifies Photon Controller persistent disk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

versioned.Event

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

true

string

object

true

string

- -
-
-

v1.Preconditions

-
-

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

User is a SELinux user label that applies to the container.

false

string

role

Role is a SELinux role label that applies to the container.

false

string

type

Type is a SELinux type label that applies to the container.

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

Version of the schema the FieldPath is written in terms of, defaults to "v1".

false

string

fieldPath

Path of the field to select in the specified API version.

true

string

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

false

boolean

false

mountPath

Path within the container at which the volume should be mounted. Must not contain :.

true

string

subPath

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

false

string

- -
-
-

v1.NFSVolumeSource

-
-

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

path

Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

boolean

false

- -
-
-

v1.PersistentVolumeClaimSpec

-
-

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

accessModes

AccessModes contains the desired access modes the volume should have. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes-1

false

v1.PersistentVolumeAccessMode array

selector

A label query over volumes to consider for binding.

false

unversioned.LabelSelector

resources

Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#resources

false

v1.ResourceRequirements

volumeName

VolumeName is the binding reference to the PersistentVolume backing this claim.

false

string

- -
-
-

v1.CephFSVolumeSource

-
-

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

true

string array

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

string

user

Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretFile

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.DownwardAPIVolumeSource

-
-

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusCause

-
-

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

A machine-readable description of the cause of the error. If this value is empty there is no information available.

false

string

message

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

false

string

field

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"

false

string

- -
-
-

v1beta1.StatefulSetStatus

-
-

StatefulSetStatus represents the current state of a StatefulSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

most recent generation observed by this autoscaler.

false

integer (int64)

replicas

Replicas is the number of actual replicas.

true

integer (int32)

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

integer (int32)

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

boolean

false

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.LocalObjectReference

-
-

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

- -
-
-

v1.Container

-
-

A single application container that you want to run within a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

image

Docker image name. More info: http://kubernetes.io/docs/user-guide/images

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

List of environment variables to set in the container. Cannot be updated.

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md

false

v1.SecurityContext

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

false

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1beta1.StatefulSetSpec

-
-

A StatefulSetSpec is the specification of a StatefulSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

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.

false

integer (int32)

selector

Selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

template

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.

true

v1.PodTemplateSpec

volumeClaimTemplates

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.

false

v1.PersistentVolumeClaim array

serviceName

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.

true

string

- -
-
-

v1.ObjectMeta

-
-

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

false

string

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

types.UID

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

true

string

- -
-
-

v1.AzureFileVolumeSource

-
-

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

the name of secret that contains Azure Storage Account Name and Key

true

string

shareName

Share Name

true

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.ISCSIVolumeSource

-
-

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi

false

string

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

string

- -
-
-

unversioned.Patch

-
-

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

-
-
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.PersistentVolumeClaim

-
-

PersistentVolumeClaim is a user’s request for and claim to a persistent volume

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the desired characteristics of a volume requested by a pod author. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

false

v1.PersistentVolumeClaimSpec

status

Status represents the current information/status of a persistent volume claim. Read-only. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

false

v1.PersistentVolumeClaimStatus

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

boolean

false

- -
-
-

v1.FlockerVolumeSource

-
-

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

string

datasetUUID

UUID of the dataset. This is unique identifier of a Flocker dataset

false

string

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1.PersistentVolumeClaimStatus

-
-

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

phase

Phase represents the current phase of PersistentVolumeClaim.

false

string

accessModes

AccessModes contains the actual access modes the volume backing the PVC has. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes-1

false

v1.PersistentVolumeAccessMode array

capacity

Represents the actual resources of the underlying volume.

false

object

- -
-
-

v1.QuobyteVolumeSource

-
-

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

- -
-
-

unversioned.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

unversioned.LabelSelectorRequirement array

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.PersistentVolumeAccessMode

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

false

object

- -
-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

Driver is the name of the driver to use for this volume.

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

Selects a key of a secret in the pod’s namespace

false

v1.SecretKeySelector

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.AzureDiskVolumeSource

-
-

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

false

- -
-
-

v1beta1.StatefulSet

-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

false

v1.ObjectMeta

spec

Spec defines the desired identities of pods in this set.

false

v1beta1.StatefulSetSpec

status

Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

false

v1beta1.StatefulSetStatus

- -
-
-

v1.Volume

-
-

Volume represents a named volume in a pod that may be accessed by any container in the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

false

v1.HostPathVolumeSource

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

v1.SecretVolumeSource

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

photonPersistentDisk

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

false

v1.PhotonPersistentDiskVolumeSource

- -
-
-

v1.ResourceFieldSelector

-
-

ResourceFieldSelector represents container resources (cpu, memory) and their output format

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

- -
-
-

v1.Probe

-
-

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

- -
-
-

unversioned.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

unversioned.APIResourceList

-
-

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key of the secret to select from. Must be a valid secret key.

true

string

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

APIResource specifies the name of a resource and whether it is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

true

string

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

true

string

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key to select.

true

string

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

- -
-
-

v1.GlusterfsVolumeSource

-
-

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

- -
-
-

v1beta1.StatefulSetList

-
-

StatefulSetList is a collection of StatefulSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

false

unversioned.ListMeta

items

true

v1beta1.StatefulSet array

- -
-
-

v1.AzureDataDiskCachingMode

- -
-
-

v1.RBDVolumeSource

-
-

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#rbd

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - diff --git a/docs/api-reference/batch/v1/definitions.html b/docs/api-reference/batch/v1/definitions.html deleted file mode 100755 index 20ecb4cf031d1..0000000000000 --- a/docs/api-reference/batch/v1/definitions.html +++ /dev/null @@ -1,4033 +0,0 @@ ---- -title: Batch API Definitions ---- - - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1.PhotonPersistentDiskVolumeSource

-
-

Represents a Photon Controller persistent disk resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdID

ID that identifies Photon Controller persistent disk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

versioned.Event

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

true

string

object

true

string

- -
-
-

v1.Preconditions

-
-

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

User is a SELinux user label that applies to the container.

false

string

role

Role is a SELinux role label that applies to the container.

false

string

type

Type is a SELinux type label that applies to the container.

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

Version of the schema the FieldPath is written in terms of, defaults to "v1".

false

string

fieldPath

Path of the field to select in the specified API version.

true

string

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

false

boolean

false

mountPath

Path within the container at which the volume should be mounted. Must not contain :.

true

string

subPath

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

false

string

- -
-
-

v1.NFSVolumeSource

-
-

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

path

Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

boolean

false

- -
-
-

v1.CephFSVolumeSource

-
-

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

true

string array

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

string

user

Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretFile

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.DownwardAPIVolumeSource

-
-

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusCause

-
-

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

A machine-readable description of the cause of the error. If this value is empty there is no information available.

false

string

message

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

false

string

field

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"

false

string

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

integer (int32)

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

boolean

false

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.LocalObjectReference

-
-

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

- -
-
-

v1.Container

-
-

A single application container that you want to run within a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

image

Docker image name. More info: http://kubernetes.io/docs/user-guide/images

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

List of environment variables to set in the container. Cannot be updated.

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md

false

v1.SecurityContext

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

false

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.JobStatus

-
-

JobStatus represents the current state of a Job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

conditions

Conditions represent the latest available observations of an object’s current state. More info: http://kubernetes.io/docs/user-guide/jobs

false

v1.JobCondition array

startTime

StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

completionTime

CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

active

Active is the number of actively running pods.

false

integer (int32)

succeeded

Succeeded is the number of pods which reached Phase Succeeded.

false

integer (int32)

failed

Failed is the number of pods which reached Phase Failed.

false

integer (int32)

- -
-
-

v1.ObjectMeta

-
-

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

false

string

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

types.UID

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

true

string

- -
-
-

v1.AzureFileVolumeSource

-
-

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

the name of secret that contains Azure Storage Account Name and Key

true

string

shareName

Share Name

true

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.ISCSIVolumeSource

-
-

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi

false

string

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

string

- -
-
-

unversioned.Patch

-
-

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

-
-
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

boolean

false

- -
-
-

v1.FlockerVolumeSource

-
-

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

string

datasetUUID

UUID of the dataset. This is unique identifier of a Flocker dataset

false

string

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1.QuobyteVolumeSource

-
-

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

- -
-
-

v1.Job

-
-

Job represents the configuration of a single job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.JobSpec

status

Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.JobStatus

- -
-
-

unversioned.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

unversioned.LabelSelectorRequirement array

- -
-
-

v1.JobCondition

-
-

JobCondition describes current state of a job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of job condition, Complete or Failed.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastProbeTime

Last time the condition was checked.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.JobList

-
-

JobList is a collection of jobs.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is the list of Job.

true

v1.Job array

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

false

object

- -
-
-

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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

Driver is the name of the driver to use for this volume.

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

Selects a key of a secret in the pod’s namespace

false

v1.SecretKeySelector

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.AzureDiskVolumeSource

-
-

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.JobSpec

-
-

JobSpec describes how the job execution will look like.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

parallelism

Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs

false

integer (int32)

completions

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs

false

integer (int32)

activeDeadlineSeconds

Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

false

integer (int64)

selector

Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

manualSelector

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: http://releases.k8s.io/HEAD/docs/design/selector-generation.md

false

boolean

false

template

Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs

true

v1.PodTemplateSpec

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

false

- -
-
-

v1.Volume

-
-

Volume represents a named volume in a pod that may be accessed by any container in the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

false

v1.HostPathVolumeSource

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

v1.SecretVolumeSource

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

photonPersistentDisk

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

false

v1.PhotonPersistentDiskVolumeSource

- -
-
-

v1.ResourceFieldSelector

-
-

ResourceFieldSelector represents container resources (cpu, memory) and their output format

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

- -
-
-

v1.Probe

-
-

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

- -
-
-

unversioned.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

unversioned.APIResourceList

-
-

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key of the secret to select from. Must be a valid secret key.

true

string

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

APIResource specifies the name of a resource and whether it is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

true

string

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

true

string

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key to select.

true

string

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

- -
-
-

v1.GlusterfsVolumeSource

-
-

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

- -
-
-

v1.AzureDataDiskCachingMode

- -
-
-

v1.RBDVolumeSource

-
-

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#rbd

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - diff --git a/docs/api-reference/extensions/v1beta1/definitions.html b/docs/api-reference/extensions/v1beta1/definitions.html deleted file mode 100755 index 7830bf56664e4..0000000000000 --- a/docs/api-reference/extensions/v1beta1/definitions.html +++ /dev/null @@ -1,6475 +0,0 @@ ---- -title: Extensions API Definitions ---- - - - - - - - -Top Level API Objects - - - -
-
-

Top Level API Objects

-
-
- -
-
-
-
-

Definitions

-
-
-

v1beta1.DeploymentStatus

-
-

DeploymentStatus is the most recently observed status of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

The generation observed by the deployment controller.

false

integer (int64)

replicas

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

false

integer (int32)

updatedReplicas

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

false

integer (int32)

availableReplicas

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

false

integer (int32)

unavailableReplicas

Total number of unavailable pods targeted by this deployment.

false

integer (int32)

conditions

Represents the latest available observations of a deployment’s current state.

false

v1beta1.DeploymentCondition array

- -
-
-

v1beta1.DaemonSetStatus

-
-

DaemonSetStatus represents the current status of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

currentNumberScheduled

CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md

true

integer (int32)

numberMisscheduled

NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md

true

integer (int32)

desiredNumberScheduled

DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md

true

integer (int32)

numberReady

NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

true

integer (int32)

- -
-
-

v1beta1.Job

-
-

Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobSpec

status

Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.JobStatus

- -
-
-

v1.Preconditions

-
-

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

- -
-
-

v1.ObjectFieldSelector

-
-

ObjectFieldSelector selects an APIVersioned field of an object.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

Version of the schema the FieldPath is written in terms of, defaults to "v1".

false

string

fieldPath

Path of the field to select in the specified API version.

true

string

- -
-
-

v1.SELinuxOptions

-
-

SELinuxOptions are the labels to be applied to the container

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

user

User is a SELinux user label that applies to the container.

false

string

role

Role is a SELinux role label that applies to the container.

false

string

type

Type is a SELinux type label that applies to the container.

false

string

level

Level is SELinux level label that applies to the container.

false

string

- -
-
-

v1.VolumeMount

-
-

VolumeMount describes a mounting of a Volume within a container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

This must match the Name of a Volume.

true

string

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

false

boolean

false

mountPath

Path within the container at which the volume should be mounted. Must not contain :.

true

string

subPath

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

false

string

- -
-
-

v1beta1.IngressSpec

-
-

IngressSpec describes the Ingress the user wishes to exist.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

backend

A default backend capable of servicing requests that don’t match any rule. At least one of backend or rules must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.

false

v1beta1.IngressBackend

tls

TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

false

v1beta1.IngressTLS array

rules

A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

false

v1beta1.IngressRule array

- -
-
-

v1beta1.IngressBackend

-
-

IngressBackend describes all endpoints for a given service and port.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

serviceName

Specifies the name of the referenced service.

true

string

servicePort

Specifies the port of the referenced service.

true

string

- -
-
-

v1beta1.ReplicaSetList

-
-

ReplicaSetList is a collection of ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of ReplicaSets. More info: http://kubernetes.io/docs/user-guide/replication-controller

true

v1beta1.ReplicaSet array

- -
-
-

v1.CephFSVolumeSource

-
-

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

true

string array

path

Optional: Used as the mounted root, rather than the full Ceph tree, default is /

false

string

user

Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretFile

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretRef

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1beta1.IngressStatus

-
-

IngressStatus describe the current state of the Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

loadBalancer

LoadBalancer contains the current status of the load-balancer.

false

v1.LoadBalancerStatus

- -
-
-

v1.DownwardAPIVolumeSource

-
-

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

unversioned.StatusCause

-
-

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

reason

A machine-readable description of the cause of the error. If this value is empty there is no information available.

false

string

message

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

false

string

field

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-
-Examples:
- "name" - the field "name" on the current resource
- "items[0].name" - the field "name" on the first array entry in "items"

false

string

- -
-
-

v1beta1.ReplicaSetCondition

-
-

ReplicaSetCondition describes the state of a replica set at a certain point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of replica set condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastTransitionTime

The last time the condition transitioned from one status to another.

false

string (date-time)

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

- -
-
-

v1beta1.NetworkPolicyList

-
-

Network Policy List is a list of NetworkPolicy objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is a list of schema objects.

true

v1beta1.NetworkPolicy array

- -
-
-

v1.GCEPersistentDiskVolumeSource

-
-

Represents a Persistent Disk resource in Google Compute Engine.

-
-
-

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdName

Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

integer (int32)

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

boolean

false

- -
-
-

v1beta1.RollingUpdateDeployment

-
-

Spec to control the desired behavior of rolling update.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

maxUnavailable

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

false

string

maxSurge

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.

false

string

- -
-
-

v1beta1.HTTPIngressRuleValue

-
-

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

paths

A collection of paths that map requests to backends.

true

v1beta1.HTTPIngressPath array

- -
-
-

v1.ConfigMapVolumeSource

-
-

Adapts a ConfigMap into a volume.

-
-
-

The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

items

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.GitRepoVolumeSource

-
-

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

false

string

- -
-
-

v1beta1.JobStatus

-
-

JobStatus represents the current state of a Job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

conditions

Conditions represent the latest available observations of an object’s current state. More info: http://kubernetes.io/docs/user-guide/jobs

false

v1beta1.JobCondition array

startTime

StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

completionTime

CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

string (date-time)

active

Active is the number of actively running pods.

false

integer (int32)

succeeded

Succeeded is the number of pods which reached Phase Succeeded.

false

integer (int32)

failed

Failed is the number of pods which reached Phase Failed.

false

integer (int32)

- -
-
-

v1.Capabilities

-
-

Adds and removes POSIX capabilities from running containers.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

- -
-
-

v1.LocalObjectReference

-
-

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

- -
-
-

v1.ExecAction

-
-

ExecAction describes a "run in container" action.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

command

Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

false

string array

- -
-
-

v1.ObjectMeta

-
-

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-
-If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-
-Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-
-Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

false

string

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-
-Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-
-Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-
-Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-
-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

- -
-
-

v1beta1.ReplicaSetSpec

-
-

ReplicaSetSpec is the specification of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

false

integer (int32)

minReadySeconds

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

false

integer (int32)

selector

Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

false

v1.PodTemplateSpec

- -
-
-

v1beta1.DaemonSetSpec

-
-

DaemonSetSpec is the specification of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selector

Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

template

Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template

true

v1.PodTemplateSpec

- -
-
-

v1beta1.Deployment

-
-

Deployment enables declarative updates for Pods and ReplicaSets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata.

false

v1.ObjectMeta

spec

Specification of the desired behavior of the Deployment.

false

v1beta1.DeploymentSpec

status

Most recently observed status of the Deployment.

false

v1beta1.DeploymentStatus

- -
-
-

v1.AzureFileVolumeSource

-
-

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

the name of secret that contains Azure Storage Account Name and Key

true

string

shareName

Share Name

true

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

types.UID

- -
-
-

v1.ISCSIVolumeSource

-
-

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPortal

iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.

false

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi

false

string

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

false

boolean

false

- -
-
-

v1.EmptyDirVolumeSource

-
-

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

medium

What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

string

- -
-
-

v1beta1.IngressList

-
-

IngressList is a collection of Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is the list of Ingress.

true

v1beta1.Ingress array

- -
-
-

v1beta1.ScaleSpec

-
-

describes the attributes of a scale subresource

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

- -
-
-

unversioned.Patch

-
-

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

-
-
-
-

v1.FlockerVolumeSource

-
-

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

datasetName

Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated

false

string

datasetUUID

UUID of the dataset. This is unique identifier of a Flocker dataset

false

string

- -
-
-

v1.PersistentVolumeClaimVolumeSource

-
-

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

claimName

ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

- -
-
-

unversioned.ListMeta

-
-

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

- -
-
-

v1beta1.HorizontalPodAutoscaler

-
-

configuration of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.

false

v1beta1.HorizontalPodAutoscalerSpec

status

current information about the autoscaler.

false

v1beta1.HorizontalPodAutoscalerStatus

- -
-
-

unversioned.LabelSelector

-
-

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

false

object

matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

false

unversioned.LabelSelectorRequirement array

- -
-
-

v1beta1.RollbackConfig

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

revision

The revision to rollback to. If set to 0, rollbck to the last revision.

false

integer (int64)

- -
-
-

v1.SecretVolumeSource

-
-

Adapts a Secret into a volume.

-
-
-

The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

secretName

Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

string

items

If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.EnvVarSource

-
-

EnvVarSource represents a source for the value of an EnvVar.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

Selects a key of a secret in the pod’s namespace

false

v1.SecretKeySelector

- -
-
-

v1.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.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

driver

Driver is the name of the driver to use for this volume.

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

false

string

secretRef

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

false

v1.LocalObjectReference

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

options

Optional: Extra command options if any.

false

object

- -
-
-

v1beta1.JobCondition

-
-

JobCondition describes current state of a job.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of job condition, Complete or Failed.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastProbeTime

Last time the condition was checked.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

(brief) reason for the condition’s last transition.

false

string

message

Human readable message indicating details about last transition.

false

string

- -
-
-

v1.LoadBalancerIngress

-
-

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ip

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

false

string

hostname

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

false

string

- -
-
-

v1beta1.APIVersion

-
-

An APIVersion represents a single concrete version of an object model.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of this version (e.g. v1).

false

string

- -
-
-

v1.AzureDiskVolumeSource

-
-

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1.KeyToPath

-
-

Maps a string key to a path within a volume.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

The key to project.

true

string

path

The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.VsphereVirtualDiskVolumeSource

-
-

Represents a vSphere volume resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1.DeleteOptions

-
-

DeleteOptions may be provided when deleting an API object

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

false

- -
-
-

v1.Volume

-
-

Volume represents a named volume in a pod that may be accessed by any container in the pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

hostPath

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

false

v1.HostPathVolumeSource

emptyDir

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

false

v1.SecretVolumeSource

nfs

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

v1.NFSVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

downwardAPI

DownwardAPI represents downward API about the pod that should populate this volume

false

v1.DownwardAPIVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

photonPersistentDisk

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

false

v1.PhotonPersistentDiskVolumeSource

- -
-
-

v1beta1.DaemonSetList

-
-

DaemonSetList is a collection of daemon sets.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is a list of daemon sets.

true

v1beta1.DaemonSet array

- -
-
-

v1.ResourceFieldSelector

-
-

ResourceFieldSelector represents container resources (cpu, memory) and their output format

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

Specifies the output format of the exposed resources, defaults to "1"

false

string

- -
-
-

v1.Probe

-
-

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

integer (int32)

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

false

integer (int32)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

false

integer (int32)

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

false

integer (int32)

- -
-
-

v1beta1.DeploymentSpec

-
-

DeploymentSpec is the specification of the desired behavior of the Deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

false

integer (int32)

selector

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.

false

unversioned.LabelSelector

template

Template describes the pods that will be created.

true

v1.PodTemplateSpec

strategy

The deployment strategy to use to replace existing pods with new ones.

false

v1beta1.DeploymentStrategy

minReadySeconds

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

false

integer (int32)

revisionHistoryLimit

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.

false

integer (int32)

paused

Indicates that the deployment is paused and will not be processed by the deployment controller.

false

boolean

false

rollbackTo

The config this deployment is rolling back to. Will be cleared after rollback is done.

false

v1beta1.RollbackConfig

progressDeadlineSeconds

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.

false

integer (int32)

- -
-
-

unversioned.APIResourceList

-
-

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

- -
-
-

v1.SecretKeySelector

-
-

SecretKeySelector selects a key of a Secret.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key of the secret to select from. Must be a valid secret key.

true

string

- -
-
-

v1.Capability

- -
-
-

unversioned.APIResource

-
-

APIResource specifies the name of a resource and whether it is namespaced.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

true

string

- -
-
-

v1.DownwardAPIVolumeFile

-
-

DownwardAPIVolumeFile represents information to create the file containing the pod field

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

true

string

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

- -
-
-

v1.ContainerPort

-
-

ContainerPort represents a network port in a single container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

hostIP

What host IP to bind the external port to.

false

string

- -
-
-

v1.PodSpec

-
-

PodSpec is a description of a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

- -
-
-

v1.Lifecycle

-
-

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io//docs/concepts/containers/container-lifecycle-hooks#hook-details

false

v1.Handler

- -
-
-

v1.GlusterfsVolumeSource

-
-

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

- -
-
-

v1.Handler

-
-

Handler defines a specific action that should be taken

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

- -
-
-

v1beta1.IngressTLS

-
-

IngressTLS describes the transport layer security associated with an Ingress.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

hosts

Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.

false

string array

secretName

SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

false

string

- -
-
-

v1beta1.SubresourceReference

-
-

SubresourceReference contains enough information to let you inspect or modify the referred subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

name

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

apiVersion

API version of the referent

false

string

subresource

Subresource name of the referent

false

string

- -
-
-

v1beta1.Scale

-
-

represents a scaling request for a resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.

false

v1.ObjectMeta

spec

defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.

false

v1beta1.ScaleSpec

status

current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.

false

v1beta1.ScaleStatus

- -
-
-

v1.RBDVolumeSource

-
-

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#rbd

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

- -
-
-

v1.PhotonPersistentDiskVolumeSource

-
-

Represents a Photon Controller persistent disk resource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

pdID

ID that identifies Photon Controller persistent disk

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

- -
-
-

v1beta1.NetworkPolicy

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior for this NetworkPolicy.

false

v1beta1.NetworkPolicySpec

- -
-
-

versioned.Event

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

true

string

object

true

string

- -
-
-

v1beta1.ScaleStatus

-
-

represents the current status of a scale subresource.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

object

targetSelector

label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

string

- -
-
-

v1beta1.NetworkPolicySpec

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.

true

unversioned.LabelSelector

ingress

List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list.

false

v1beta1.NetworkPolicyIngressRule array

- -
-
-

v1.NFSVolumeSource

-
-

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

path

Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs

false

boolean

false

- -
-
-

v1beta1.DeploymentList

-
-

DeploymentList is a list of Deployments.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of Deployments.

true

v1beta1.Deployment array

- -
-
-

v1beta1.DeploymentRollback

-
-

DeploymentRollback stores the information required to rollback a deployment.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

name

Required: This must match the Name of a deployment.

true

string

updatedAnnotations

The annotations to be updated to a deployment

false

object

rollbackTo

The config of this deployment rollback.

true

v1beta1.RollbackConfig

- -
-
-

v1.HTTPHeader

-
-

HTTPHeader describes a custom header to be used in HTTP probes

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

- -
-
-

v1beta1.HorizontalPodAutoscalerStatus

-
-

current status of a horizontal pod autoscaler

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

observedGeneration

most recent generation observed by this autoscaler.

false

integer (int64)

lastScaleTime

last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.

false

string (date-time)

currentReplicas

current number of replicas of pods managed by this autoscaler.

true

integer (int32)

desiredReplicas

desired number of replicas of pods managed by this autoscaler.

true

integer (int32)

currentCPUUtilizationPercentage

current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.

false

integer (int32)

- -
-
-

v1.FCVolumeSource

-
-

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

- -
-
-

v1beta1.ThirdPartyResource

-
-

A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object metadata

false

v1.ObjectMeta

description

Description is the description of this object.

false

string

versions

Versions are versions for this third party object

false

v1beta1.APIVersion array

- -
-
-

v1.TCPSocketAction

-
-

TCPSocketAction describes an action based on opening a socket

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

- -
-
-

v1beta1.DeploymentStrategy

-
-

DeploymentStrategy describes how to replace existing pods with new ones.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

false

string

rollingUpdate

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

false

v1beta1.RollingUpdateDeployment

- -
-
-

v1beta1.IngressRule

-
-

IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

host

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
- 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.

false

string

http

false

v1beta1.HTTPIngressRuleValue

- -
-
-

v1beta1.JobList

-
-

JobList is a collection of jobs. DEPRECATED: extensions/v1beta1.JobList is deprecated, use batch/v1.JobList instead.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

items

Items is the list of Job.

true

v1beta1.Job array

- -
-
-

v1beta1.NetworkPolicyPeer

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

podSelector

This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.

false

unversioned.LabelSelector

namespaceSelector

Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.

false

unversioned.LabelSelector

- -
-
-

unversioned.StatusDetails

-
-

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

- -
-
-

v1.HTTPGetAction

-
-

HTTPGetAction describes an action based on HTTP Get requests.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

- -
-
-

v1.LoadBalancerStatus

-
-

LoadBalancerStatus represents the status of a load-balancer.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ingress

Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

false

v1.LoadBalancerIngress array

- -
-
-

v1beta1.CPUTargetUtilization

- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

targetPercentage

fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use.

true

integer (int32)

- -
-
-

v1.Container

-
-

A single application container that you want to run within a pod.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

image

Docker image name. More info: http://kubernetes.io/docs/user-guide/images

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

List of environment variables to set in the container. Cannot be updated.

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/concepts/storage/persistent-volumes/#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes

false

v1.Probe

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md

false

v1.SecurityContext

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

false

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

false

boolean

false

- -
-
-

v1.PodSecurityContext

-
-

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
-
-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

false

integer (int64)

- -
-
-

v1beta1.NetworkPolicyIngressRule

-
-

This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

ports

List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.

false

v1beta1.NetworkPolicyPort array

from

List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.

false

v1beta1.NetworkPolicyPeer array

- -
-
-

v1.OwnerReference

-
-

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

true

string

uid

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

- -
-
-

v1beta1.ReplicaSetStatus

-
-

ReplicaSetStatus represents the current status of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

The number of pods that have labels matching the labels of the pod template of the replicaset.

false

integer (int32)

readyReplicas

The number of ready replicas for this replica set.

false

integer (int32)

availableReplicas

The number of available replicas (ready for at least minReadySeconds) for this replica set.

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

false

integer (int64)

conditions

Represents the latest available observations of a replica set’s current state.

false

v1beta1.ReplicaSetCondition array

- -
-
-

v1beta1.ReplicaSet

-
-

ReplicaSet represents the configuration of a ReplicaSet.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the specification of the desired behavior of the ReplicaSet. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.ReplicaSetSpec

status

Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.ReplicaSetStatus

- -
-
-

v1.HostPathVolumeSource

-
-

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath

true

string

- -
-
-

v1beta1.DaemonSet

-
-

DaemonSet represents the configuration of a daemon set.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.DaemonSetSpec

status

Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.DaemonSetStatus

- -
-
-

v1.CinderVolumeSource

-
-

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false

boolean

false

- -
-
-

v1.SecurityContext

-
-

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

- -
-
-

v1.Protocol

- -
-
-

v1.AWSElasticBlockStoreVolumeSource

-
-

Represents a Persistent Disk resource in AWS.

-
-
-

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore

false

boolean

false

- -
-
-

v1beta1.HorizontalPodAutoscalerSpec

-
-

specification of a horizontal pod autoscaler.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

scaleRef

reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec.

true

v1beta1.SubresourceReference

minReplicas

lower limit for the number of pods that can be set by the autoscaler, default 1.

false

integer (int32)

maxReplicas

upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

true

integer (int32)

cpuUtilization

target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources.

false

v1beta1.CPUTargetUtilization

- -
-
-

v1.QuobyteVolumeSource

-
-

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

- -
-
-

v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

- -
-
-

v1.ResourceRequirements

-
-

ResourceRequirements describes the compute resource requirements.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

false

object

- -
-
-

v1.PodTemplateSpec

-
-

PodTemplateSpec describes the data a pod should have when created from a template

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

- -
-
-

v1beta1.NetworkPolicyPort

- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

protocol

Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

false

v1.Protocol

port

If specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.

false

string

- -
-
-

v1beta1.DeploymentCondition

-
-

DeploymentCondition describes the state of a deployment at a certain point.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

type

Type of deployment condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastUpdateTime

The last time this condition was updated.

false

string (date-time)

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string (date-time)

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

- -
-
-

v1beta1.JobSpec

-
-

JobSpec describes how the job execution will look like.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

parallelism

Parallelism specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: http://kubernetes.io/docs/user-guide/jobs

false

integer (int32)

completions

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://kubernetes.io/docs/user-guide/jobs

false

integer (int32)

activeDeadlineSeconds

Optional duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

false

integer (int64)

selector

Selector is a label query over pods that should match the pod count. Normally, the system sets this field for you. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors

false

unversioned.LabelSelector

autoSelector

AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md

false

boolean

false

template

Template is the object that describes the pod that will be created when executing a job. More info: http://kubernetes.io/docs/user-guide/jobs

true

v1.PodTemplateSpec

- -
-
-

unversioned.LabelSelectorRequirement

-
-

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

- -
-
-

unversioned.Status

-
-

Status is a return value for calls that don’t return other objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

- -
-
-

v1beta1.HorizontalPodAutoscalerList

-
-

list of horizontal pod autoscaler objects.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

list of horizontal pod autoscaler objects.

true

v1beta1.HorizontalPodAutoscaler array

- -
-
-

v1.ConfigMapKeySelector

-
-

Selects a key from a ConfigMap.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

false

string

key

The key to select.

true

string

- -
-
-

v1beta1.HTTPIngressPath

-
-

HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

path

Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e. this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend.

false

string

backend

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

true

v1beta1.IngressBackend

- -
-
-

v1beta1.Ingress

-
-

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec is the desired state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.IngressSpec

status

Status is the current state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false

v1beta1.IngressStatus

- -
-
-

v1beta1.ThirdPartyResourceList

-
-

ThirdPartyResourceList is a list of ThirdPartyResources.

-
- ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of ThirdPartyResources.

true

v1beta1.ThirdPartyResource array

- -
-
-

v1.AzureDataDiskCachingMode

- -
-
-

any

-
-

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

-
-
-
-
-
- - - diff --git a/docs/api-reference/v1.9/index.html b/docs/api-reference/v1.9/index.html deleted file mode 100644 index fe638458b2327..0000000000000 --- a/docs/api-reference/v1.9/index.html +++ /dev/null @@ -1,103420 +0,0 @@ - - - - -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

-

Worloads 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://'.
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
202
CronJob		Accepted
200
CronJob		OK
201
CronJob		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 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.
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.
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.
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.
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.
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.
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
201
CronJob		Created
200
CronJob		OK
-
-

DaemonSet v1beta2 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
appsv1beta2DaemonSet
- - - -

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
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/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.
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.
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.
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.
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.
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.
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
-
-

Deployment v1beta2 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
appsv1beta2Deployment
- - - -

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 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. Defaults to 25%. 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/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
201
Deployment		Created
200
Deployment		OK
-

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.
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.
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.
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.
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.
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.
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
-
-

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
200
Job		OK
201
Job		Created
202
Job		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 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.
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.
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.
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.
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.
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.
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
201
Job		Created
200
Job		OK
-
-

Pod v1 core

-
-

Pod Config to print "Hello World".

-
-

-apiVersion: v1
-kind: Pod
-metadata:
-  name: pod-example
-spec:
-  containers:
-  - image: ubuntu:trusty
-    command: ["echo"]
-    args: ["Hello World"]
-
-
-

Pod Config to print "Hello World".

-
-

-apiVersion: v1
-kind: Pod
-metadata:
-  name: pod-example
-spec:
-  containers:
-  - 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. This is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
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'. Note that 'None' policy is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
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" is a special keyword which indicates 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.
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/
subdomain
string		If specified, the fully qualified Pod hostname will be "...svc.". 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.
phase
string		Current condition 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://kubernetes.io/docs/tasks/configure-pod-container/quality-service-pod/
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
-

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.
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.
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.
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.
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.
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.
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
-

Create Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy POST requests to Pod

-

HTTP Request

-

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Create Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy POST requests to Pod

-

HTTP Request

-

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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
-

Delete Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy DELETE requests to Pod

-

HTTP Request

-

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Delete Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy DELETE requests to Pod

-

HTTP Request

-

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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
-

Get Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy GET requests to Pod

-

HTTP Request

-

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Get Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy GET requests to Pod

-

HTTP Request

-

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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
-

Replace Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy PUT requests to Pod

-

HTTP Request

-

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Replace Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy PUT requests to Pod

-

HTTP Request

-

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Pod
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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 v1beta2 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
appsv1beta2ReplicaSet
- - - - - - -

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.
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.
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.
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.
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.
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.
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
201
ReplicaSet		Created
200
ReplicaSet		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
202
ReplicationController		Accepted
200
ReplicationController		OK
201
ReplicationController		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 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.
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.
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.
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.
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.
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.
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
-
-

StatefulSet v1beta2 apps

- - - - - - - - - - - - - - - -
GroupVersionKind
appsv1beta2StatefulSet
- - - -

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.
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.
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.
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.
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.
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.
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
201
StatefulSet		Created
200
StatefulSet		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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
200
Ingress		OK
201
Ingress		Created
-
-

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. This field will replace the service.alpha.kubernetes.io/tolerate-unready-endpoints when that annotation is deprecated and all clients have been converted to use this field.
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
201
Service		Created
202
Service		Accepted
200
Service		OK
-

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.
-

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.
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.
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.
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.
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.
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
200
Service		OK
201
Service		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 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
-

Create Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy POST requests to Service

-

HTTP Request

-

POST /api/v1/proxy/namespaces/{namespace}/services/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Create Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy POST requests to Service

-

HTTP Request

-

POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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
-

Delete Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy DELETE requests to Service

-

HTTP Request

-

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Delete Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy DELETE requests to Service

-

HTTP Request

-

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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
-

Get Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy GET requests to Service

-

HTTP Request

-

GET /api/v1/proxy/namespaces/{namespace}/services/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Get Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy GET requests to Service

-

HTTP Request

-

GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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
-

Replace Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy PUT requests to Service

-

HTTP Request

-

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Replace Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy PUT requests to Service

-

HTTP Request

-

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
pathpath to the resource
-

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
data
object		Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'.
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
200
ConfigMap		OK
201
ConfigMap		Created
202
ConfigMap		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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
201
PersistentVolumeClaim		Created
200
PersistentVolumeClaim		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 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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
storagev1StorageClass
- - - -

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
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.
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.
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.
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.
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. This is an alpha feature and may change in future.
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.
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
-

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 v1beta2 apps

- - - - - - - - - - - - - - - -
GroupVersionKind
appsv1beta2ControllerRevision
- - - -

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
201
ControllerRevision		Created
202
ControllerRevision		Accepted
200
ControllerRevision		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 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
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/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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
apiextensionsv1beta1CustomResourceDefinition
-

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
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
validation
CustomResourceValidation		Validation describes the validation methods for CustomResources
version
string		Version is the version this resource belongs in
-

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
-

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
200
CustomResourceDefinition		OK
201
CustomResourceDefinition		Created
202
CustomResourceDefinition		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 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
200
CustomResourceDefinition		OK
201
CustomResourceDefinition		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 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.
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.
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.
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.
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...

-

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
201
CustomResourceDefinition		Created
200
CustomResourceDefinition		OK
-
-

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
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 /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
200
Event		OK
201
Event		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 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.
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.
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.
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.
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.
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.
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
201
LimitRange		Created
200
LimitRange		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 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.
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.
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.
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.
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.
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.
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
202
HorizontalPodAutoscaler		Accepted
200
HorizontalPodAutoscaler		OK
201
HorizontalPodAutoscaler		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 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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
admissionregistrationv1alpha1InitializerConfiguration
-

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
201
InitializerConfiguration		Created
202
InitializerConfiguration		Accepted
200
InitializerConfiguration		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 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
200
InitializerConfiguration		OK
201
InitializerConfiguration		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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
201
PodDisruptionBudget		Created
200
PodDisruptionBudget		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 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.
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.
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.
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.
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.
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.
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 v1alpha1 scheduling

- - - - - - - - - - - - - - - -
GroupVersionKind
schedulingv1alpha1PriorityClass
- - - - - - -

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.
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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/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
202
PriorityClass		Accepted
200
PriorityClass		OK
201
PriorityClass		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 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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
settingsv1alpha1PodPreset
- - - - - - -

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
201
PodPreset		Created
202
PodPreset		Accepted
200
PodPreset		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 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
201
PodPreset		Created
200
PodPreset		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 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.
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.
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.
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.
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.
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.
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
-

Pod Security Policy 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 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		is a white list of allowed host paths. Empty indicates that all host paths may be used.
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.
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 all plugins may be used.
-

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
202
PodSecurityPolicy		Accepted
200
PodSecurityPolicy		OK
201
PodSecurityPolicy		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 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.
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.
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.
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.
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 v1beta1 apiregistration

- - - - - - - - - - - - - - - -
GroupVersionKind
apiregistrationv1beta1APIService
-

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). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s.
-

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
201
APIService		Created
200
APIService		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 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.
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.
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.
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.
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...

-

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
-
-

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
201
Binding		Created
202
Binding		Accepted
200
Binding		OK
-
-

CertificateSigningRequest v1beta1 certificates

- - - - - - - - - - - - - - - -
GroupVersionKind
certificatesv1beta1CertificateSigningRequest
-

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
200
CertificateSigningRequest		OK
201
CertificateSigningRequest		Created
202
CertificateSigningRequest		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 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.
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.
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.
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.
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...

-

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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1ClusterRole
- - - -

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
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/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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1ClusterRoleBinding
- - - -

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
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/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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1LocalSubjectAccessReview
- - - -

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
201
LocalSubjectAccessReview		Created
202
LocalSubjectAccessReview		Accepted
200
LocalSubjectAccessReview		OK
-
-

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
200
Namespace		OK
201
Namespace		Created
202
Namespace		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 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.
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.
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.
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
200
Namespace		OK
201
Namespace		Created
-
-

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		External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.
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: ://
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
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
200
Node		OK
201
Node		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 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.
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.
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.
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.
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
-

Create Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy POST requests to Node

-

HTTP Request

-

POST /api/v1/proxy/nodes/{name}

-

Path Parameters

- - - - - - - - - - - - - -
ParameterDescription
namename of the Node
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Create Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy POST requests to Node

-

HTTP Request

-

POST /api/v1/proxy/nodes/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Node
pathpath to the resource
-

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
-

Delete Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy DELETE requests to Node

-

HTTP Request

-

DELETE /api/v1/proxy/nodes/{name}

-

Path Parameters

- - - - - - - - - - - - - -
ParameterDescription
namename of the Node
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Delete Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy DELETE requests to Node

-

HTTP Request

-

DELETE /api/v1/proxy/nodes/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Node
pathpath to the resource
-

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
-

Get Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy GET requests to Node

-

HTTP Request

-

GET /api/v1/proxy/nodes/{name}

-

Path Parameters

- - - - - - - - - - - - - -
ParameterDescription
namename of the Node
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Get Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy GET requests to Node

-

HTTP Request

-

GET /api/v1/proxy/nodes/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Node
pathpath to the resource
-

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
-

Replace Proxy

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy PUT requests to Node

-

HTTP Request

-

PUT /api/v1/proxy/nodes/{name}

-

Path Parameters

- - - - - - - - - - - - - -
ParameterDescription
namename of the Node
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
string		OK
-

Replace Proxy Path

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

proxy PUT requests to Node

-

HTTP Request

-

PUT /api/v1/proxy/nodes/{name}/{path}

-

Path Parameters

- - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Node
pathpath to the resource
-

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
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
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
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. This is an alpha feature and may change in future.
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
persistentVolumeReclaimPolicy
string		What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. 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
201
PersistentVolume		Created
202
PersistentVolume		Accepted
200
PersistentVolume		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 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.
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.
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.
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.
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/
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.
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.
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.
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.
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.
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.
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
200
ResourceQuota		OK
201
ResourceQuota		Created
-
-

Role v1 rbac

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1Role
- - - -

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
201
Role		Created
202
Role		Accepted
200
Role		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 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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1RoleBinding
- - - -

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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1SelfSubjectAccessReview
- - - -

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
201
SelfSubjectAccessReview		Created
202
SelfSubjectAccessReview		Accepted
200
SelfSubjectAccessReview		OK
-
-

SelfSubjectRulesReview v1 authorization

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1SelfSubjectRulesReview
- - - -

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
202
SelfSubjectRulesReview		Accepted
200
SelfSubjectRulesReview		OK
201
SelfSubjectRulesReview		Created
-
-

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
200
ServiceAccount		OK
201
ServiceAccount		Created
202
ServiceAccount		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 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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1SubjectAccessReview
- - - -

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
200
SubjectAccessReview		OK
201
SubjectAccessReview		Created
202
SubjectAccessReview		Accepted
-
-

TokenReview v1 authentication

- - - - - - - - - - - - - - - -
GroupVersionKind
authenticationv1TokenReview
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
networkingv1NetworkPolicy
- - - -

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.
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.
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.
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.
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.
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.
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 v1beta1 apiregistration

- - - - - - - - - - - - - - - -
GroupVersionKind
apiregistrationv1beta1APIServiceCondition
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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
rbacv1AggregationRule
- - -

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.

- - - - - - - - - - - - - - - -
FieldDescription
driver
string		Driver is the name of the Flexvolume driver.
-

AllowedHostPath v1beta1 extensions

- - - - - - - - - - - - - - - -
GroupVersionKind
extensionsv1beta1AllowedHostPath
-

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		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
-

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

- - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
driver
string		Driver is the name of the driver to use for this volume. Required.
readOnly
boolean		Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
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
certificatesv1beta1CertificateSigningRequestCondition
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
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.
-

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
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
-

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://'
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.
-

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.
-

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"
name
string		Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
-

CustomResourceDefinitionCondition v1beta1 apiextensions

- - - - - - - - - - - - - - - -
GroupVersionKind
apiextensionsv1beta1CustomResourceDefinitionCondition
-

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
apiextensionsv1beta1CustomResourceDefinitionNames
-

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
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 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
-

CustomResourceValidation v1beta1 apiextensions

- - - - - - - - - - - - - - - -
GroupVersionKind
apiextensionsv1beta1CustomResourceValidation
-

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.
-

DaemonSet v1 apps

- - - - - - - - - - - - - - - -
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
-

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.
-

Deployment v1 apps

- - - - - - - - - - - - - - - -
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.
-

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 identifer 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 continously for some time.

- - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
count
integer		Number of occurrences in this series up to the last heartbeat time
lastObservedTime
MicroTime		Time of the last occurence 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//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
apiextensionsv1beta1ExternalDocumentation
-

ExternalDocumentation allows referencing an external resource for extended documentation.

- - - - - - - - - - - - - - - - - - - -
FieldDescription
description
string
url
string
-

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.

- - - - - - - - - - - - - - - - - - - -
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.
rule
string		Rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
-

FlexVolumeSource v1 core

- - - - - - - - - - - - - - - -
GroupVersionKind
Corev1FlexVolumeSource
-

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.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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.

- - - - - - - - - - - - - - - - - - - - - - - -
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:///? -> 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
-

Host Port Range 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 extensions

- - - - - - - - - - - - - - - -
GroupVersionKind
extensionsv1beta1IDRange
-

ID Range 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 v1 networking

- - - - - - - - - - - - - - - -
GroupVersionKind
networkingv1IPBlock
- - -

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 : 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 : 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
apiextensionsv1beta1JSON
-

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
apiextensionsv1beta1JSONSchemaProps
-

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
apiextensionsv1beta1JSONSchemaPropsOrArray
-

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
apiextensionsv1beta1JSONSchemaPropsOrBool
-

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

- - - - - - - - - - - - - - - -
FieldDescription
path
string		The full path to the volume on the node For alpha, this path must be a directory Once block as a source is supported, then this path can point to a block device
-

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
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 match one of the fields below.
-

MetricStatus v2beta1 autoscaling

- - - - - - - - - - - - - - - -
GroupVersionKind
autoscalingv2beta1MetricStatus
-

MetricStatus describes the last-read state of a single metric.

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
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 match one of the fields below.
-

MicroTime v1 meta

- - - - - - - - - - - - - - - -
GroupVersionKind
metav1MicroTime
- - - - - - - - - - - - - - -
FieldDescription
-

MutatingWebhookConfiguration v1beta1 admissionregistration

- - - - - - - - - - - - - - - -
GroupVersionKind
admissionregistrationv1beta1MutatingWebhookConfiguration
-

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.
-

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
networkingv1NetworkPolicyEgressRule
- - -

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
networkingv1NetworkPolicyIngressRule
- - -

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
networkingv1NetworkPolicyPeer
- - -

NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.

- - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
ipBlock
IPBlock		IPBlock defines policy on a particular IPBlock
namespaceSelector
LabelSelector		Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
podSelector
LabelSelector		This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this namespace.
-

NetworkPolicyPort v1 networking

- - - - - - - - - - - - - - - -
GroupVersionKind
networkingv1NetworkPolicyPort
- - -

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
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
configMapRef
ObjectReference
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
-

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.

- - - - - - - - - - - - - - - -
FieldDescription
matchExpressions
NodeSelectorRequirement array		Required. A list of node selector requirements. The requirements are ANDed.
-

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
authorizationv1NonResourceAttributes
- - -

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
authorizationv1NonResourceRule
- - -

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 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. Currently only Ready. 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
-

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.
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.
-

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
rbacv1PolicyRule
- - -

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
-

ReplicaSet v1 apps

- - - - - - - - - - - - - - - -
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
-

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
authorizationv1ResourceAttributes
- - -

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
authorizationv1ResourceRule
- - -

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
rbacv1RoleRef
- - -

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
admissionregistrationv1alpha1Rule
-

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
admissionregistrationv1beta1RuleWithOperations
-

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
-

Run A sUser Strategy Options 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.
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
-

SELinux Strategy Options defines the strategy type and any options used to create the strategy.

- - - - - - - - - - - - - - - - - - - -
FieldDescription
rule
string		type 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.
-

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.
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.
-

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 v1beta1 admissionregistration

- - - - - - - - - - - - - - - -
GroupVersionKind
admissionregistrationv1beta1ServiceReference
-

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.
-

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.
-

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.
-

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
rbacv1Subject
- - -

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
authorizationv1SubjectRulesReviewStatus
- - -

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.

- - - - - - - - - - - - - - - - - - - -
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.
rule
string		Rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
-

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 using the matching 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.
-

UserInfo v1 authentication

- - - - - - - - - - - - - - - -
GroupVersionKind
authenticationv1UserInfo
- - -

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.
-

ValidatingWebhookConfiguration v1beta1 admissionregistration

- - - - - - - - - - - - - - - -
GroupVersionKind
admissionregistrationv1beta1ValidatingWebhookConfiguration
-

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.
-

VolumeAttachment v1alpha1 storage

- - - - - - - - - - - - - - - -
GroupVersionKind
storagev1alpha1VolumeAttachment
-

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.
-

VolumeAttachmentSource v1alpha1 storage

- - - - - - - - - - - - - - - -
GroupVersionKind
storagev1alpha1VolumeAttachmentSource
-

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 v1alpha1 storage

- - - - - - - - - - - - - - - -
GroupVersionKind
storagev1alpha1VolumeError
-

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 alpha in 1.8 and can be reworked or removed in a future release.
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).
-

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
-

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
admissionregistrationv1beta1Webhook
-

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 other cluster scoped resource, it is not subjected to 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.
-

WebhookClientConfig v1beta1 admissionregistration

- - - - - - - - - - - - - - - -
GroupVersionKind
admissionregistrationv1beta1WebhookClientConfig
-

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. If there is only one port open for the service, that port will be used. If there are multiple ports open, 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://". 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.

-
-

AggregationRule v1beta1 rbac

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1AggregationRule
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1AggregationRule
- - - -

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
-
-

ClusterRole v1beta1 rbac

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1ClusterRole
- - - -

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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1ClusterRole
- - - -

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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1ClusterRoleBinding
- - - -

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
201
ClusterRoleBinding		Created
202
ClusterRoleBinding		Accepted
200
ClusterRoleBinding		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 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
201
ClusterRoleBinding		Created
200
ClusterRoleBinding		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 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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1ClusterRoleBinding
- - - -

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.
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.
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.
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.
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
- - - -

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
201
ControllerRevision		Created
202
ControllerRevision		Accepted
200
ControllerRevision		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 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
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/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.
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.
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.
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.
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.
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.
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
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/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
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/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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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"
name
string		Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
-
-

DaemonSet v1beta2 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
appsv1beta2DaemonSet
- - - -

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
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/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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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

-
-

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
appsv1beta2Deployment
- - - -

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 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. Defaults to 25%. 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/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
201
Deployment		Created
200
Deployment		OK
-

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.
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.
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.
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.
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.
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.
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
-
-

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 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. Defaults to 25%. 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/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
201
Deployment		Created
202
Deployment		Accepted
200
Deployment		OK
-

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
201
Deployment		Created
200
Deployment		OK
-

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.
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.
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.
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.
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.
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.
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
-
-

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.
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.
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.
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.
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.
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.
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
-
-

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

- - - - - - - - - - - - - - - -
GroupVersionKind
eventsv1beta1Event
- - - -

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
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 /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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
eventsv1beta1EventSeries
- - - -

EventSeries contain information on series of events, i.e. thing that was/is happening continously 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.
-
-

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
200
HorizontalPodAutoscaler		OK
201
HorizontalPodAutoscaler		Created
202
HorizontalPodAutoscaler		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 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.
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.
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.
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.
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.
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.
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
-
-

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

- - - - - - - - - - - - - - - -
GroupVersionKind
admissionregistrationv1alpha1Initializer
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1LocalSubjectAccessReview
- - - -

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
201
NetworkPolicy		Created
202
NetworkPolicy		Accepted
200
NetworkPolicy		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 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.
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.
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.
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.
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.
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.
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
namespaceSelector
LabelSelector		Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If present but empty, this selector selects all namespaces.
podSelector
LabelSelector		This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If present but empty, this selector selects all pods in this 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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1NonResourceAttributes
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1NonResourceRule
- - - -

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.
-
-

PolicyRule v1beta1 rbac

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1PolicyRule
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1PolicyRule
- - - -

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.
-
-

ReplicaSet v1beta2 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
appsv1beta2ReplicaSet
- - - - - - -

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.
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.
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.
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.
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.
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.
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
201
ReplicaSet		Created
200
ReplicaSet		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
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/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.
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.
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.
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.
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.
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.
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
200
ReplicaSet		OK
201
ReplicaSet		Created
-
-

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1ResourceAttributes
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1ResourceRule
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1Role
- - - -

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
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/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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1Role
- - - -

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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1RoleBinding
- - - -

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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1RoleBinding
- - - -

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
201
RoleBinding		Created
202
RoleBinding		Accepted
200
RoleBinding		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 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.
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.
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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1RoleRef
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1RoleRef
- - - -

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.
-
-

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1SelfSubjectAccessReview
- - - -

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
201
SelfSubjectAccessReview		Created
202
SelfSubjectAccessReview		Accepted
200
SelfSubjectAccessReview		OK
-
-

SelfSubjectRulesReview v1beta1 authorization

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1SelfSubjectRulesReview
- - - -

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
202
SelfSubjectRulesReview		Accepted
200
SelfSubjectRulesReview		OK
201
SelfSubjectRulesReview		Created
-
-

ServiceReference v1beta1 apiregistration

- - - - - - - - - - - - - - - -
GroupVersionKind
apiregistrationv1beta1ServiceReference
-

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
- - - -

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.
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.
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.
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.
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.
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.
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
201
StatefulSet		Created
200
StatefulSet		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
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/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
201
StatefulSet		Created
200
StatefulSet		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 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.
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.
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.
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.
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.
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.
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
-
-

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

- - - - - - - - - - - - - - - -
GroupVersionKind
storagev1beta1StorageClass
- - - -

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
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
201
StorageClass		Created
202
StorageClass		Accepted
200
StorageClass		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 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.
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.
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.
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.
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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1beta1Subject
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
rbacv1alpha1Subject
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1SubjectAccessReview
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authorizationv1beta1SubjectRulesReviewStatus
- - - -

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.
-
-

TokenReview v1beta1 authentication

- - - - - - - - - - - - - - - -
GroupVersionKind
authenticationv1beta1TokenReview
- - - -

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

- - - - - - - - - - - - - - - -
GroupVersionKind
authenticationv1beta1UserInfo
- - - -

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.
-
-
- - - - - - - - \ No newline at end of file diff --git a/docs/api-reference/v1.9/navData.js b/docs/api-reference/v1.9/navData.js deleted file mode 100644 index 7ab0b42c5602a..0000000000000 --- a/docs/api-reference/v1.9/navData.js +++ /dev/null @@ -1 +0,0 @@ -(function(){navData = {"toc":[{"section":"userinfo-v1beta1-authentication","subsections":[]},{"section":"tokenreview-v1beta1-authentication","subsections":[{"section":"-strong-write-operations-strong--935","subsections":[{"section":"create-936"}]}]},{"section":"subjectrulesreviewstatus-v1beta1-authorization","subsections":[]},{"section":"subjectaccessreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--933","subsections":[{"section":"create-934"}]}]},{"section":"subject-v1alpha1-rbac","subsections":[]},{"section":"subject-v1beta1-rbac","subsections":[]},{"section":"storageclass-v1beta1-storage","subsections":[{"section":"-strong-read-operations-strong--928","subsections":[{"section":"watch-list-932"},{"section":"watch-931"},{"section":"list-930"},{"section":"read-929"}]},{"section":"-strong-write-operations-strong--922","subsections":[{"section":"delete-collection-927"},{"section":"delete-926"},{"section":"replace-925"},{"section":"patch-924"},{"section":"create-923"}]}]},{"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-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":"statefulset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--901","subsections":[{"section":"replace-status-904"},{"section":"read-status-903"},{"section":"patch-status-902"}]},{"section":"-strong-read-operations-strong--894","subsections":[{"section":"watch-list-all-namespaces-900"},{"section":"watch-list-899"},{"section":"watch-898"},{"section":"list-all-namespaces-897"},{"section":"list-896"},{"section":"read-895"}]},{"section":"-strong-write-operations-strong--888","subsections":[{"section":"delete-collection-893"},{"section":"delete-892"},{"section":"replace-891"},{"section":"patch-890"},{"section":"create-889"}]}]},{"section":"servicereference-v1beta1-apiregistration","subsections":[]},{"section":"selfsubjectrulesreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--886","subsections":[{"section":"create-887"}]}]},{"section":"selfsubjectaccessreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--884","subsections":[{"section":"create-885"}]}]},{"section":"scale-v1beta1-extensions","subsections":[]},{"section":"scale-v1beta1-apps","subsections":[]},{"section":"scale-v1beta2-apps","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1beta1-apps","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1beta2-apps","subsections":[]},{"section":"rollbackconfig-v1beta1-extensions","subsections":[]},{"section":"roleref-v1alpha1-rbac","subsections":[]},{"section":"roleref-v1beta1-rbac","subsections":[]},{"section":"rolebinding-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--877","subsections":[{"section":"watch-list-all-namespaces-883"},{"section":"watch-list-882"},{"section":"watch-881"},{"section":"list-all-namespaces-880"},{"section":"list-879"},{"section":"read-878"}]},{"section":"-strong-write-operations-strong--871","subsections":[{"section":"delete-collection-876"},{"section":"delete-875"},{"section":"replace-874"},{"section":"patch-873"},{"section":"create-872"}]}]},{"section":"rolebinding-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--864","subsections":[{"section":"watch-list-all-namespaces-870"},{"section":"watch-list-869"},{"section":"watch-868"},{"section":"list-all-namespaces-867"},{"section":"list-866"},{"section":"read-865"}]},{"section":"-strong-write-operations-strong--858","subsections":[{"section":"delete-collection-863"},{"section":"delete-862"},{"section":"replace-861"},{"section":"patch-860"},{"section":"create-859"}]}]},{"section":"role-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--851","subsections":[{"section":"watch-list-all-namespaces-857"},{"section":"watch-list-856"},{"section":"watch-855"},{"section":"list-all-namespaces-854"},{"section":"list-853"},{"section":"read-852"}]},{"section":"-strong-write-operations-strong--845","subsections":[{"section":"delete-collection-850"},{"section":"delete-849"},{"section":"replace-848"},{"section":"patch-847"},{"section":"create-846"}]}]},{"section":"role-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--838","subsections":[{"section":"watch-list-all-namespaces-844"},{"section":"watch-list-843"},{"section":"watch-842"},{"section":"list-all-namespaces-841"},{"section":"list-840"},{"section":"read-839"}]},{"section":"-strong-write-operations-strong--832","subsections":[{"section":"delete-collection-837"},{"section":"delete-836"},{"section":"replace-835"},{"section":"patch-834"},{"section":"create-833"}]}]},{"section":"resourcerule-v1beta1-authorization","subsections":[]},{"section":"resourceattributes-v1beta1-authorization","subsections":[]},{"section":"replicasetcondition-v1beta1-extensions","subsections":[]},{"section":"replicasetcondition-v1beta2-apps","subsections":[]},{"section":"replicaset-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--828","subsections":[{"section":"replace-status-831"},{"section":"read-status-830"},{"section":"patch-status-829"}]},{"section":"-strong-read-operations-strong--821","subsections":[{"section":"watch-list-all-namespaces-827"},{"section":"watch-list-826"},{"section":"watch-825"},{"section":"list-all-namespaces-824"},{"section":"list-823"},{"section":"read-822"}]},{"section":"-strong-write-operations-strong--815","subsections":[{"section":"delete-collection-820"},{"section":"delete-819"},{"section":"replace-818"},{"section":"patch-817"},{"section":"create-816"}]}]},{"section":"replicaset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--811","subsections":[{"section":"replace-status-814"},{"section":"read-status-813"},{"section":"patch-status-812"}]},{"section":"-strong-read-operations-strong--804","subsections":[{"section":"watch-list-all-namespaces-810"},{"section":"watch-list-809"},{"section":"watch-808"},{"section":"list-all-namespaces-807"},{"section":"list-806"},{"section":"read-805"}]},{"section":"-strong-write-operations-strong--798","subsections":[{"section":"delete-collection-803"},{"section":"delete-802"},{"section":"replace-801"},{"section":"patch-800"},{"section":"create-799"}]}]},{"section":"policyrule-v1alpha1-rbac","subsections":[]},{"section":"policyrule-v1beta1-rbac","subsections":[]},{"section":"nonresourcerule-v1beta1-authorization","subsections":[]},{"section":"nonresourceattributes-v1beta1-authorization","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--791","subsections":[{"section":"watch-list-all-namespaces-797"},{"section":"watch-list-796"},{"section":"watch-795"},{"section":"list-all-namespaces-794"},{"section":"list-793"},{"section":"read-792"}]},{"section":"-strong-write-operations-strong--785","subsections":[{"section":"delete-collection-790"},{"section":"delete-789"},{"section":"replace-788"},{"section":"patch-787"},{"section":"create-786"}]}]},{"section":"localsubjectaccessreview-v1beta1-authorization","subsections":[{"section":"-strong-write-operations-strong--783","subsections":[{"section":"create-784"}]}]},{"section":"jobtemplatespec-v2alpha1-batch","subsections":[]},{"section":"initializer-v1alpha1-admissionregistration","subsections":[]},{"section":"ipblock-v1beta1-extensions","subsections":[]},{"section":"horizontalpodautoscaler-v2beta1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--779","subsections":[{"section":"replace-status-782"},{"section":"read-status-781"},{"section":"patch-status-780"}]},{"section":"-strong-read-operations-strong--772","subsections":[{"section":"watch-list-all-namespaces-778"},{"section":"watch-list-777"},{"section":"watch-776"},{"section":"list-all-namespaces-775"},{"section":"list-774"},{"section":"read-773"}]},{"section":"-strong-write-operations-strong--766","subsections":[{"section":"delete-collection-771"},{"section":"delete-770"},{"section":"replace-769"},{"section":"patch-768"},{"section":"create-767"}]}]},{"section":"eventseries-v1beta1-events","subsections":[]},{"section":"event-v1beta1-events","subsections":[{"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":"deploymentcondition-v1beta1-extensions","subsections":[]},{"section":"deploymentcondition-v1beta1-apps","subsections":[]},{"section":"deploymentcondition-v1beta2-apps","subsections":[]},{"section":"deployment-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":"deployment-v1beta1-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":"deployment-v1beta2-apps","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":"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--698","subsections":[{"section":"replace-status-701"},{"section":"read-status-700"},{"section":"patch-status-699"}]},{"section":"-strong-read-operations-strong--691","subsections":[{"section":"watch-list-all-namespaces-697"},{"section":"watch-list-696"},{"section":"watch-695"},{"section":"list-all-namespaces-694"},{"section":"list-693"},{"section":"read-692"}]},{"section":"-strong-write-operations-strong--685","subsections":[{"section":"delete-collection-690"},{"section":"delete-689"},{"section":"replace-688"},{"section":"patch-687"},{"section":"create-686"}]}]},{"section":"daemonset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--681","subsections":[{"section":"replace-status-684"},{"section":"read-status-683"},{"section":"patch-status-682"}]},{"section":"-strong-read-operations-strong--674","subsections":[{"section":"watch-list-all-namespaces-680"},{"section":"watch-list-679"},{"section":"watch-678"},{"section":"list-all-namespaces-677"},{"section":"list-676"},{"section":"read-675"}]},{"section":"-strong-write-operations-strong--668","subsections":[{"section":"delete-collection-673"},{"section":"delete-672"},{"section":"replace-671"},{"section":"patch-670"},{"section":"create-669"}]}]},{"section":"crossversionobjectreference-v2beta1-autoscaling","subsections":[]},{"section":"cronjob-v2alpha1-batch","subsections":[{"section":"-strong-status-operations-strong--664","subsections":[{"section":"replace-status-667"},{"section":"read-status-666"},{"section":"patch-status-665"}]},{"section":"-strong-read-operations-strong--657","subsections":[{"section":"watch-list-all-namespaces-663"},{"section":"watch-list-662"},{"section":"watch-661"},{"section":"list-all-namespaces-660"},{"section":"list-659"},{"section":"read-658"}]},{"section":"-strong-write-operations-strong--651","subsections":[{"section":"delete-collection-656"},{"section":"delete-655"},{"section":"replace-654"},{"section":"patch-653"},{"section":"create-652"}]}]},{"section":"controllerrevision-v1beta1-apps","subsections":[{"section":"-strong-read-operations-strong--644","subsections":[{"section":"watch-list-all-namespaces-650"},{"section":"watch-list-649"},{"section":"watch-648"},{"section":"list-all-namespaces-647"},{"section":"list-646"},{"section":"read-645"}]},{"section":"-strong-write-operations-strong--638","subsections":[{"section":"delete-collection-643"},{"section":"delete-642"},{"section":"replace-641"},{"section":"patch-640"},{"section":"create-639"}]}]},{"section":"controllerrevision-v1beta2-apps","subsections":[{"section":"-strong-read-operations-strong--631","subsections":[{"section":"watch-list-all-namespaces-637"},{"section":"watch-list-636"},{"section":"watch-635"},{"section":"list-all-namespaces-634"},{"section":"list-633"},{"section":"read-632"}]},{"section":"-strong-write-operations-strong--625","subsections":[{"section":"delete-collection-630"},{"section":"delete-629"},{"section":"replace-628"},{"section":"patch-627"},{"section":"create-626"}]}]},{"section":"clusterrolebinding-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--620","subsections":[{"section":"watch-list-624"},{"section":"watch-623"},{"section":"list-622"},{"section":"read-621"}]},{"section":"-strong-write-operations-strong--614","subsections":[{"section":"delete-collection-619"},{"section":"delete-618"},{"section":"replace-617"},{"section":"patch-616"},{"section":"create-615"}]}]},{"section":"clusterrolebinding-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--609","subsections":[{"section":"watch-list-613"},{"section":"watch-612"},{"section":"list-611"},{"section":"read-610"}]},{"section":"-strong-write-operations-strong--603","subsections":[{"section":"delete-collection-608"},{"section":"delete-607"},{"section":"replace-606"},{"section":"patch-605"},{"section":"create-604"}]}]},{"section":"clusterrole-v1alpha1-rbac","subsections":[{"section":"-strong-read-operations-strong--598","subsections":[{"section":"watch-list-602"},{"section":"watch-601"},{"section":"list-600"},{"section":"read-599"}]},{"section":"-strong-write-operations-strong--592","subsections":[{"section":"delete-collection-597"},{"section":"delete-596"},{"section":"replace-595"},{"section":"patch-594"},{"section":"create-593"}]}]},{"section":"clusterrole-v1beta1-rbac","subsections":[{"section":"-strong-read-operations-strong--587","subsections":[{"section":"watch-list-591"},{"section":"watch-590"},{"section":"list-589"},{"section":"read-588"}]},{"section":"-strong-write-operations-strong--581","subsections":[{"section":"delete-collection-586"},{"section":"delete-585"},{"section":"replace-584"},{"section":"patch-583"},{"section":"create-582"}]}]},{"section":"aggregationrule-v1alpha1-rbac","subsections":[]},{"section":"aggregationrule-v1beta1-rbac","subsections":[]},{"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":"volumemount-v1-core"},{"section":"volumeerror-v1alpha1-storage"},{"section":"volumedevice-v1-core"},{"section":"volumeattachmentsource-v1alpha1-storage"},{"section":"volumeattachment-v1alpha1-storage"},{"section":"validatingwebhookconfiguration-v1beta1-admissionregistration"},{"section":"userinfo-v1-authentication"},{"section":"toleration-v1-core"},{"section":"time-v1-meta"},{"section":"taint-v1-core"},{"section":"tcpsocketaction-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":"statefulset-v1-apps"},{"section":"sessionaffinityconfig-v1-core"},{"section":"servicereference-v1beta1-admissionregistration"},{"section":"serviceport-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":"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":"replicaset-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":"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":"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":"mutatingwebhookconfiguration-v1beta1-admissionregistration"},{"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":"fsgroupstrategyoptions-v1beta1-extensions"},{"section":"fcvolumesource-v1-core"},{"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":"deployment-v1-apps"},{"section":"deleteoptions-v1-meta"},{"section":"daemonsetupdatestrategy-v1-apps"},{"section":"daemonsetcondition-v1-apps"},{"section":"daemonset-v1-apps"},{"section":"daemonendpoint-v1-core"},{"section":"customresourcevalidation-v1beta1-apiextensions"},{"section":"customresourcedefinitionnames-v1beta1-apiextensions"},{"section":"customresourcedefinitioncondition-v1beta1-apiextensions"},{"section":"crossversionobjectreference-v1-autoscaling"},{"section":"controllerrevision-v1-apps"},{"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":"configmapkeyselector-v1-core"},{"section":"configmapenvsource-v1-core"},{"section":"componentcondition-v1-core"},{"section":"clientipconfig-v1-core"},{"section":"cindervolumesource-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-v1beta1-apiregistration"},{"section":"apiresource-v1-meta"},{"section":"apigroup-v1-meta"}]},{"section":"networkpolicy-v1-networking","subsections":[{"section":"-strong-read-operations-strong--574","subsections":[{"section":"watch-list-all-namespaces-580"},{"section":"watch-list-579"},{"section":"watch-578"},{"section":"list-all-namespaces-577"},{"section":"list-576"},{"section":"read-575"}]},{"section":"-strong-write-operations-strong--568","subsections":[{"section":"delete-collection-573"},{"section":"delete-572"},{"section":"replace-571"},{"section":"patch-570"},{"section":"create-569"}]}]},{"section":"tokenreview-v1-authentication","subsections":[{"section":"-strong-write-operations-strong--566","subsections":[{"section":"create-567"}]}]},{"section":"subjectaccessreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--564","subsections":[{"section":"create-565"}]}]},{"section":"serviceaccount-v1-core","subsections":[{"section":"-strong-read-operations-strong--557","subsections":[{"section":"watch-list-all-namespaces-563"},{"section":"watch-list-562"},{"section":"watch-561"},{"section":"list-all-namespaces-560"},{"section":"list-559"},{"section":"read-558"}]},{"section":"-strong-write-operations-strong--551","subsections":[{"section":"delete-collection-556"},{"section":"delete-555"},{"section":"replace-554"},{"section":"patch-553"},{"section":"create-552"}]}]},{"section":"selfsubjectrulesreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--549","subsections":[{"section":"create-550"}]}]},{"section":"selfsubjectaccessreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--547","subsections":[{"section":"create-548"}]}]},{"section":"rolebinding-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--540","subsections":[{"section":"watch-list-all-namespaces-546"},{"section":"watch-list-545"},{"section":"watch-544"},{"section":"list-all-namespaces-543"},{"section":"list-542"},{"section":"read-541"}]},{"section":"-strong-write-operations-strong--534","subsections":[{"section":"delete-collection-539"},{"section":"delete-538"},{"section":"replace-537"},{"section":"patch-536"},{"section":"create-535"}]}]},{"section":"role-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--527","subsections":[{"section":"watch-list-all-namespaces-533"},{"section":"watch-list-532"},{"section":"watch-531"},{"section":"list-all-namespaces-530"},{"section":"list-529"},{"section":"read-528"}]},{"section":"-strong-write-operations-strong--521","subsections":[{"section":"delete-collection-526"},{"section":"delete-525"},{"section":"replace-524"},{"section":"patch-523"},{"section":"create-522"}]}]},{"section":"resourcequota-v1-core","subsections":[{"section":"-strong-status-operations-strong--517","subsections":[{"section":"replace-status-520"},{"section":"read-status-519"},{"section":"patch-status-518"}]},{"section":"-strong-read-operations-strong--510","subsections":[{"section":"watch-list-all-namespaces-516"},{"section":"watch-list-515"},{"section":"watch-514"},{"section":"list-all-namespaces-513"},{"section":"list-512"},{"section":"read-511"}]},{"section":"-strong-write-operations-strong--504","subsections":[{"section":"delete-collection-509"},{"section":"delete-508"},{"section":"replace-507"},{"section":"patch-506"},{"section":"create-505"}]}]},{"section":"persistentvolume-v1-core","subsections":[{"section":"-strong-status-operations-strong--500","subsections":[{"section":"replace-status-503"},{"section":"read-status-502"},{"section":"patch-status-501"}]},{"section":"-strong-read-operations-strong--495","subsections":[{"section":"watch-list-499"},{"section":"watch-498"},{"section":"list-497"},{"section":"read-496"}]},{"section":"-strong-write-operations-strong--489","subsections":[{"section":"delete-collection-494"},{"section":"delete-493"},{"section":"replace-492"},{"section":"patch-491"},{"section":"create-490"}]}]},{"section":"node-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--470","subsections":[{"section":"replace-proxy-path-488"},{"section":"replace-proxy-487"},{"section":"replace-connect-proxy-path-486"},{"section":"replace-connect-proxy-485"},{"section":"head-connect-proxy-path-484"},{"section":"head-connect-proxy-483"},{"section":"get-proxy-path-482"},{"section":"get-proxy-481"},{"section":"get-connect-proxy-path-480"},{"section":"get-connect-proxy-479"},{"section":"delete-proxy-path-478"},{"section":"delete-proxy-477"},{"section":"delete-connect-proxy-path-476"},{"section":"delete-connect-proxy-475"},{"section":"create-proxy-path-474"},{"section":"create-proxy-473"},{"section":"create-connect-proxy-path-472"},{"section":"create-connect-proxy-471"}]},{"section":"-strong-status-operations-strong--466","subsections":[{"section":"replace-status-469"},{"section":"read-status-468"},{"section":"patch-status-467"}]},{"section":"-strong-read-operations-strong--461","subsections":[{"section":"watch-list-465"},{"section":"watch-464"},{"section":"list-463"},{"section":"read-462"}]},{"section":"-strong-write-operations-strong--455","subsections":[{"section":"delete-collection-460"},{"section":"delete-459"},{"section":"replace-458"},{"section":"patch-457"},{"section":"create-456"}]}]},{"section":"namespace-v1-core","subsections":[{"section":"-strong-status-operations-strong--451","subsections":[{"section":"replace-status-454"},{"section":"read-status-453"},{"section":"patch-status-452"}]},{"section":"-strong-read-operations-strong--446","subsections":[{"section":"watch-list-450"},{"section":"watch-449"},{"section":"list-448"},{"section":"read-447"}]},{"section":"-strong-write-operations-strong--441","subsections":[{"section":"delete-445"},{"section":"replace-444"},{"section":"patch-443"},{"section":"create-442"}]}]},{"section":"localsubjectaccessreview-v1-authorization","subsections":[{"section":"-strong-write-operations-strong--439","subsections":[{"section":"create-440"}]}]},{"section":"componentstatus-v1-core","subsections":[{"section":"-strong-read-operations-strong--436","subsections":[{"section":"list-438"},{"section":"read-437"}]}]},{"section":"clusterrolebinding-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--431","subsections":[{"section":"watch-list-435"},{"section":"watch-434"},{"section":"list-433"},{"section":"read-432"}]},{"section":"-strong-write-operations-strong--425","subsections":[{"section":"delete-collection-430"},{"section":"delete-429"},{"section":"replace-428"},{"section":"patch-427"},{"section":"create-426"}]}]},{"section":"clusterrole-v1-rbac","subsections":[{"section":"-strong-read-operations-strong--420","subsections":[{"section":"watch-list-424"},{"section":"watch-423"},{"section":"list-422"},{"section":"read-421"}]},{"section":"-strong-write-operations-strong--414","subsections":[{"section":"delete-collection-419"},{"section":"delete-418"},{"section":"replace-417"},{"section":"patch-416"},{"section":"create-415"}]}]},{"section":"certificatesigningrequest-v1beta1-certificates","subsections":[{"section":"-strong-status-operations-strong--412","subsections":[{"section":"replace-status-413"}]},{"section":"-strong-read-operations-strong--407","subsections":[{"section":"watch-list-411"},{"section":"watch-410"},{"section":"list-409"},{"section":"read-408"}]},{"section":"-strong-write-operations-strong--401","subsections":[{"section":"delete-collection-406"},{"section":"delete-405"},{"section":"replace-404"},{"section":"patch-403"},{"section":"create-402"}]}]},{"section":"binding-v1-core","subsections":[{"section":"-strong-write-operations-strong--399","subsections":[{"section":"create-400"}]}]},{"section":"apiservice-v1beta1-apiregistration","subsections":[{"section":"-strong-status-operations-strong--397","subsections":[{"section":"replace-status-398"}]},{"section":"-strong-read-operations-strong--392","subsections":[{"section":"watch-list-396"},{"section":"watch-395"},{"section":"list-394"},{"section":"read-393"}]},{"section":"-strong-write-operations-strong--386","subsections":[{"section":"delete-collection-391"},{"section":"delete-390"},{"section":"replace-389"},{"section":"patch-388"},{"section":"create-387"}]}]},{"section":"-strong-cluster-strong-","subsections":[]},{"section":"podsecuritypolicy-v1beta1-extensions","subsections":[{"section":"-strong-read-operations-strong--381","subsections":[{"section":"watch-list-385"},{"section":"watch-384"},{"section":"list-383"},{"section":"read-382"}]},{"section":"-strong-write-operations-strong--375","subsections":[{"section":"delete-collection-380"},{"section":"delete-379"},{"section":"replace-378"},{"section":"patch-377"},{"section":"create-376"}]}]},{"section":"podpreset-v1alpha1-settings","subsections":[{"section":"-strong-read-operations-strong--368","subsections":[{"section":"watch-list-all-namespaces-374"},{"section":"watch-list-373"},{"section":"watch-372"},{"section":"list-all-namespaces-371"},{"section":"list-370"},{"section":"read-369"}]},{"section":"-strong-write-operations-strong--362","subsections":[{"section":"delete-collection-367"},{"section":"delete-366"},{"section":"replace-365"},{"section":"patch-364"},{"section":"create-363"}]}]},{"section":"priorityclass-v1alpha1-scheduling","subsections":[{"section":"-strong-read-operations-strong--357","subsections":[{"section":"watch-list-361"},{"section":"watch-360"},{"section":"list-359"},{"section":"read-358"}]},{"section":"-strong-write-operations-strong--351","subsections":[{"section":"delete-collection-356"},{"section":"delete-355"},{"section":"replace-354"},{"section":"patch-353"},{"section":"create-352"}]}]},{"section":"poddisruptionbudget-v1beta1-policy","subsections":[{"section":"-strong-status-operations-strong--347","subsections":[{"section":"replace-status-350"},{"section":"read-status-349"},{"section":"patch-status-348"}]},{"section":"-strong-read-operations-strong--340","subsections":[{"section":"watch-list-all-namespaces-346"},{"section":"watch-list-345"},{"section":"watch-344"},{"section":"list-all-namespaces-343"},{"section":"list-342"},{"section":"read-341"}]},{"section":"-strong-write-operations-strong--334","subsections":[{"section":"delete-collection-339"},{"section":"delete-338"},{"section":"replace-337"},{"section":"patch-336"},{"section":"create-335"}]}]},{"section":"podtemplate-v1-core","subsections":[{"section":"-strong-read-operations-strong--327","subsections":[{"section":"watch-list-all-namespaces-333"},{"section":"watch-list-332"},{"section":"watch-331"},{"section":"list-all-namespaces-330"},{"section":"list-329"},{"section":"read-328"}]},{"section":"-strong-write-operations-strong--321","subsections":[{"section":"delete-collection-326"},{"section":"delete-325"},{"section":"replace-324"},{"section":"patch-323"},{"section":"create-322"}]}]},{"section":"initializerconfiguration-v1alpha1-admissionregistration","subsections":[{"section":"-strong-read-operations-strong--316","subsections":[{"section":"watch-list-320"},{"section":"watch-319"},{"section":"list-318"},{"section":"read-317"}]},{"section":"-strong-write-operations-strong--310","subsections":[{"section":"delete-collection-315"},{"section":"delete-314"},{"section":"replace-313"},{"section":"patch-312"},{"section":"create-311"}]}]},{"section":"horizontalpodautoscaler-v1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--306","subsections":[{"section":"replace-status-309"},{"section":"read-status-308"},{"section":"patch-status-307"}]},{"section":"-strong-read-operations-strong--299","subsections":[{"section":"watch-list-all-namespaces-305"},{"section":"watch-list-304"},{"section":"watch-303"},{"section":"list-all-namespaces-302"},{"section":"list-301"},{"section":"read-300"}]},{"section":"-strong-write-operations-strong--293","subsections":[{"section":"delete-collection-298"},{"section":"delete-297"},{"section":"replace-296"},{"section":"patch-295"},{"section":"create-294"}]}]},{"section":"limitrange-v1-core","subsections":[{"section":"-strong-read-operations-strong--286","subsections":[{"section":"watch-list-all-namespaces-292"},{"section":"watch-list-291"},{"section":"watch-290"},{"section":"list-all-namespaces-289"},{"section":"list-288"},{"section":"read-287"}]},{"section":"-strong-write-operations-strong--280","subsections":[{"section":"delete-collection-285"},{"section":"delete-284"},{"section":"replace-283"},{"section":"patch-282"},{"section":"create-281"}]}]},{"section":"event-v1-core","subsections":[{"section":"-strong-read-operations-strong--273","subsections":[{"section":"watch-list-all-namespaces-279"},{"section":"watch-list-278"},{"section":"watch-277"},{"section":"list-all-namespaces-276"},{"section":"list-275"},{"section":"read-274"}]},{"section":"-strong-write-operations-strong--267","subsections":[{"section":"delete-collection-272"},{"section":"delete-271"},{"section":"replace-270"},{"section":"patch-269"},{"section":"create-268"}]}]},{"section":"customresourcedefinition-v1beta1-apiextensions","subsections":[{"section":"-strong-status-operations-strong--265","subsections":[{"section":"replace-status-266"}]},{"section":"-strong-read-operations-strong--260","subsections":[{"section":"watch-list-264"},{"section":"watch-263"},{"section":"list-262"},{"section":"read-261"}]},{"section":"-strong-write-operations-strong--254","subsections":[{"section":"delete-collection-259"},{"section":"delete-258"},{"section":"replace-257"},{"section":"patch-256"},{"section":"create-255"}]}]},{"section":"controllerrevision-v1beta2-apps","subsections":[{"section":"-strong-read-operations-strong--247","subsections":[{"section":"watch-list-all-namespaces-253"},{"section":"watch-list-252"},{"section":"watch-251"},{"section":"list-all-namespaces-250"},{"section":"list-249"},{"section":"read-248"}]},{"section":"-strong-write-operations-strong--241","subsections":[{"section":"delete-collection-246"},{"section":"delete-245"},{"section":"replace-244"},{"section":"patch-243"},{"section":"create-242"}]}]},{"section":"-strong-metadata-strong-","subsections":[]},{"section":"volume-v1-core","subsections":[]},{"section":"storageclass-v1-storage","subsections":[{"section":"-strong-read-operations-strong--236","subsections":[{"section":"watch-list-240"},{"section":"watch-239"},{"section":"list-238"},{"section":"read-237"}]},{"section":"-strong-write-operations-strong--230","subsections":[{"section":"delete-collection-235"},{"section":"delete-234"},{"section":"replace-233"},{"section":"patch-232"},{"section":"create-231"}]}]},{"section":"persistentvolumeclaim-v1-core","subsections":[{"section":"-strong-status-operations-strong--226","subsections":[{"section":"replace-status-229"},{"section":"read-status-228"},{"section":"patch-status-227"}]},{"section":"-strong-read-operations-strong--219","subsections":[{"section":"watch-list-all-namespaces-225"},{"section":"watch-list-224"},{"section":"watch-223"},{"section":"list-all-namespaces-222"},{"section":"list-221"},{"section":"read-220"}]},{"section":"-strong-write-operations-strong--213","subsections":[{"section":"delete-collection-218"},{"section":"delete-217"},{"section":"replace-216"},{"section":"patch-215"},{"section":"create-214"}]}]},{"section":"secret-v1-core","subsections":[{"section":"-strong-read-operations-strong--206","subsections":[{"section":"watch-list-all-namespaces-212"},{"section":"watch-list-211"},{"section":"watch-210"},{"section":"list-all-namespaces-209"},{"section":"list-208"},{"section":"read-207"}]},{"section":"-strong-write-operations-strong--200","subsections":[{"section":"delete-collection-205"},{"section":"delete-204"},{"section":"replace-203"},{"section":"patch-202"},{"section":"create-201"}]}]},{"section":"configmap-v1-core","subsections":[{"section":"-strong-read-operations-strong--193","subsections":[{"section":"watch-list-all-namespaces-199"},{"section":"watch-list-198"},{"section":"watch-197"},{"section":"list-all-namespaces-196"},{"section":"list-195"},{"section":"read-194"}]},{"section":"-strong-write-operations-strong--187","subsections":[{"section":"delete-collection-192"},{"section":"delete-191"},{"section":"replace-190"},{"section":"patch-189"},{"section":"create-188"}]}]},{"section":"-strong-config-storage-strong-","subsections":[]},{"section":"service-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--168","subsections":[{"section":"replace-proxy-path-186"},{"section":"replace-proxy-185"},{"section":"replace-connect-proxy-path-184"},{"section":"replace-connect-proxy-183"},{"section":"head-connect-proxy-path-182"},{"section":"head-connect-proxy-181"},{"section":"get-proxy-path-180"},{"section":"get-proxy-179"},{"section":"get-connect-proxy-path-178"},{"section":"get-connect-proxy-177"},{"section":"delete-proxy-path-176"},{"section":"delete-proxy-175"},{"section":"delete-connect-proxy-path-174"},{"section":"delete-connect-proxy-173"},{"section":"create-proxy-path-172"},{"section":"create-proxy-171"},{"section":"create-connect-proxy-path-170"},{"section":"create-connect-proxy-169"}]},{"section":"-strong-status-operations-strong--164","subsections":[{"section":"replace-status-167"},{"section":"read-status-166"},{"section":"patch-status-165"}]},{"section":"-strong-read-operations-strong--157","subsections":[{"section":"watch-list-all-namespaces-163"},{"section":"watch-list-162"},{"section":"watch-161"},{"section":"list-all-namespaces-160"},{"section":"list-159"},{"section":"read-158"}]},{"section":"-strong-write-operations-strong--152","subsections":[{"section":"delete-156"},{"section":"replace-155"},{"section":"patch-154"},{"section":"create-153"}]}]},{"section":"ingress-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--148","subsections":[{"section":"replace-status-151"},{"section":"read-status-150"},{"section":"patch-status-149"}]},{"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":"endpoints-v1-core","subsections":[{"section":"-strong-read-operations-strong--128","subsections":[{"section":"watch-list-all-namespaces-134"},{"section":"watch-list-133"},{"section":"watch-132"},{"section":"list-all-namespaces-131"},{"section":"list-130"},{"section":"read-129"}]},{"section":"-strong-write-operations-strong--122","subsections":[{"section":"delete-collection-127"},{"section":"delete-126"},{"section":"replace-125"},{"section":"patch-124"},{"section":"create-123"}]}]},{"section":"-strong-discovery-load-balancing-strong-","subsections":[]},{"section":"statefulset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--118","subsections":[{"section":"replace-status-121"},{"section":"read-status-120"},{"section":"patch-status-119"}]},{"section":"-strong-read-operations-strong--111","subsections":[{"section":"watch-list-all-namespaces-117"},{"section":"watch-list-116"},{"section":"watch-115"},{"section":"list-all-namespaces-114"},{"section":"list-113"},{"section":"read-112"}]},{"section":"-strong-write-operations-strong--105","subsections":[{"section":"delete-collection-110"},{"section":"delete-109"},{"section":"replace-108"},{"section":"patch-107"},{"section":"create-106"}]}]},{"section":"replicationcontroller-v1-core","subsections":[{"section":"-strong-status-operations-strong--101","subsections":[{"section":"replace-status-104"},{"section":"read-status-103"},{"section":"patch-status-102"}]},{"section":"-strong-read-operations-strong--94","subsections":[{"section":"watch-list-all-namespaces-100"},{"section":"watch-list-99"},{"section":"watch-98"},{"section":"list-all-namespaces-97"},{"section":"list-96"},{"section":"read-95"}]},{"section":"-strong-write-operations-strong--88","subsections":[{"section":"delete-collection-93"},{"section":"delete-92"},{"section":"replace-91"},{"section":"patch-90"},{"section":"create-89"}]}]},{"section":"replicaset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--84","subsections":[{"section":"replace-status-87"},{"section":"read-status-86"},{"section":"patch-status-85"}]},{"section":"-strong-read-operations-strong--77","subsections":[{"section":"watch-list-all-namespaces-83"},{"section":"watch-list-82"},{"section":"watch-81"},{"section":"list-all-namespaces-80"},{"section":"list-79"},{"section":"read-78"}]},{"section":"-strong-write-operations-strong--71","subsections":[{"section":"delete-collection-76"},{"section":"delete-75"},{"section":"replace-74"},{"section":"patch-73"},{"section":"create-72"}]}]},{"section":"pod-v1-core","subsections":[{"section":"-strong-misc-operations-strong-","subsections":[{"section":"read-log"}]},{"section":"-strong-proxy-operations-strong-","subsections":[{"section":"replace-proxy-path"},{"section":"replace-proxy"},{"section":"replace-connect-proxy-path"},{"section":"replace-connect-proxy"},{"section":"head-connect-proxy-path"},{"section":"head-connect-proxy"},{"section":"get-proxy-path"},{"section":"get-proxy"},{"section":"get-connect-proxy-path"},{"section":"get-connect-proxy"},{"section":"get-connect-portforward"},{"section":"delete-proxy-path"},{"section":"delete-proxy"},{"section":"delete-connect-proxy-path"},{"section":"delete-connect-proxy"},{"section":"create-proxy-path"},{"section":"create-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-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-v1beta2-apps","subsections":[{"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-v1beta2-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":["userinfo-v1beta1-authentication","create-936","-strong-write-operations-strong--935","tokenreview-v1beta1-authentication","subjectrulesreviewstatus-v1beta1-authorization","create-934","-strong-write-operations-strong--933","subjectaccessreview-v1beta1-authorization","subject-v1alpha1-rbac","subject-v1beta1-rbac","watch-list-932","watch-931","list-930","read-929","-strong-read-operations-strong--928","delete-collection-927","delete-926","replace-925","patch-924","create-923","-strong-write-operations-strong--922","storageclass-v1beta1-storage","statefulsetupdatestrategy-v1beta1-apps","statefulsetupdatestrategy-v1beta2-apps","statefulsetcondition-v1beta1-apps","statefulsetcondition-v1beta2-apps","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","statefulset-v1beta1-apps","replace-status-904","read-status-903","patch-status-902","-strong-status-operations-strong--901","watch-list-all-namespaces-900","watch-list-899","watch-898","list-all-namespaces-897","list-896","read-895","-strong-read-operations-strong--894","delete-collection-893","delete-892","replace-891","patch-890","create-889","-strong-write-operations-strong--888","statefulset-v1beta2-apps","servicereference-v1beta1-apiregistration","create-887","-strong-write-operations-strong--886","selfsubjectrulesreview-v1beta1-authorization","create-885","-strong-write-operations-strong--884","selfsubjectaccessreview-v1beta1-authorization","scale-v1beta1-extensions","scale-v1beta1-apps","scale-v1beta2-apps","rollingupdatestatefulsetstrategy-v1beta1-apps","rollingupdatestatefulsetstrategy-v1beta2-apps","rollbackconfig-v1beta1-extensions","roleref-v1alpha1-rbac","roleref-v1beta1-rbac","watch-list-all-namespaces-883","watch-list-882","watch-881","list-all-namespaces-880","list-879","read-878","-strong-read-operations-strong--877","delete-collection-876","delete-875","replace-874","patch-873","create-872","-strong-write-operations-strong--871","rolebinding-v1alpha1-rbac","watch-list-all-namespaces-870","watch-list-869","watch-868","list-all-namespaces-867","list-866","read-865","-strong-read-operations-strong--864","delete-collection-863","delete-862","replace-861","patch-860","create-859","-strong-write-operations-strong--858","rolebinding-v1beta1-rbac","watch-list-all-namespaces-857","watch-list-856","watch-855","list-all-namespaces-854","list-853","read-852","-strong-read-operations-strong--851","delete-collection-850","delete-849","replace-848","patch-847","create-846","-strong-write-operations-strong--845","role-v1alpha1-rbac","watch-list-all-namespaces-844","watch-list-843","watch-842","list-all-namespaces-841","list-840","read-839","-strong-read-operations-strong--838","delete-collection-837","delete-836","replace-835","patch-834","create-833","-strong-write-operations-strong--832","role-v1beta1-rbac","resourcerule-v1beta1-authorization","resourceattributes-v1beta1-authorization","replicasetcondition-v1beta1-extensions","replicasetcondition-v1beta2-apps","replace-status-831","read-status-830","patch-status-829","-strong-status-operations-strong--828","watch-list-all-namespaces-827","watch-list-826","watch-825","list-all-namespaces-824","list-823","read-822","-strong-read-operations-strong--821","delete-collection-820","delete-819","replace-818","patch-817","create-816","-strong-write-operations-strong--815","replicaset-v1beta1-extensions","replace-status-814","read-status-813","patch-status-812","-strong-status-operations-strong--811","watch-list-all-namespaces-810","watch-list-809","watch-808","list-all-namespaces-807","list-806","read-805","-strong-read-operations-strong--804","delete-collection-803","delete-802","replace-801","patch-800","create-799","-strong-write-operations-strong--798","replicaset-v1beta2-apps","policyrule-v1alpha1-rbac","policyrule-v1beta1-rbac","nonresourcerule-v1beta1-authorization","nonresourceattributes-v1beta1-authorization","networkpolicyport-v1beta1-extensions","networkpolicypeer-v1beta1-extensions","networkpolicyingressrule-v1beta1-extensions","networkpolicyegressrule-v1beta1-extensions","watch-list-all-namespaces-797","watch-list-796","watch-795","list-all-namespaces-794","list-793","read-792","-strong-read-operations-strong--791","delete-collection-790","delete-789","replace-788","patch-787","create-786","-strong-write-operations-strong--785","networkpolicy-v1beta1-extensions","create-784","-strong-write-operations-strong--783","localsubjectaccessreview-v1beta1-authorization","jobtemplatespec-v2alpha1-batch","initializer-v1alpha1-admissionregistration","ipblock-v1beta1-extensions","replace-status-782","read-status-781","patch-status-780","-strong-status-operations-strong--779","watch-list-all-namespaces-778","watch-list-777","watch-776","list-all-namespaces-775","list-774","read-773","-strong-read-operations-strong--772","delete-collection-771","delete-770","replace-769","patch-768","create-767","-strong-write-operations-strong--766","horizontalpodautoscaler-v2beta1-autoscaling","eventseries-v1beta1-events","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","event-v1beta1-events","deploymentcondition-v1beta1-extensions","deploymentcondition-v1beta1-apps","deploymentcondition-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","deployment-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","deployment-v1beta1-apps","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","deployment-v1beta2-apps","daemonsetupdatestrategy-v1beta1-extensions","daemonsetupdatestrategy-v1beta2-apps","daemonsetcondition-v1beta1-extensions","daemonsetcondition-v1beta2-apps","replace-status-701","read-status-700","patch-status-699","-strong-status-operations-strong--698","watch-list-all-namespaces-697","watch-list-696","watch-695","list-all-namespaces-694","list-693","read-692","-strong-read-operations-strong--691","delete-collection-690","delete-689","replace-688","patch-687","create-686","-strong-write-operations-strong--685","daemonset-v1beta1-extensions","replace-status-684","read-status-683","patch-status-682","-strong-status-operations-strong--681","watch-list-all-namespaces-680","watch-list-679","watch-678","list-all-namespaces-677","list-676","read-675","-strong-read-operations-strong--674","delete-collection-673","delete-672","replace-671","patch-670","create-669","-strong-write-operations-strong--668","daemonset-v1beta2-apps","crossversionobjectreference-v2beta1-autoscaling","replace-status-667","read-status-666","patch-status-665","-strong-status-operations-strong--664","watch-list-all-namespaces-663","watch-list-662","watch-661","list-all-namespaces-660","list-659","read-658","-strong-read-operations-strong--657","delete-collection-656","delete-655","replace-654","patch-653","create-652","-strong-write-operations-strong--651","cronjob-v2alpha1-batch","watch-list-all-namespaces-650","watch-list-649","watch-648","list-all-namespaces-647","list-646","read-645","-strong-read-operations-strong--644","delete-collection-643","delete-642","replace-641","patch-640","create-639","-strong-write-operations-strong--638","controllerrevision-v1beta1-apps","watch-list-all-namespaces-637","watch-list-636","watch-635","list-all-namespaces-634","list-633","read-632","-strong-read-operations-strong--631","delete-collection-630","delete-629","replace-628","patch-627","create-626","-strong-write-operations-strong--625","controllerrevision-v1beta2-apps","watch-list-624","watch-623","list-622","read-621","-strong-read-operations-strong--620","delete-collection-619","delete-618","replace-617","patch-616","create-615","-strong-write-operations-strong--614","clusterrolebinding-v1alpha1-rbac","watch-list-613","watch-612","list-611","read-610","-strong-read-operations-strong--609","delete-collection-608","delete-607","replace-606","patch-605","create-604","-strong-write-operations-strong--603","clusterrolebinding-v1beta1-rbac","watch-list-602","watch-601","list-600","read-599","-strong-read-operations-strong--598","delete-collection-597","delete-596","replace-595","patch-594","create-593","-strong-write-operations-strong--592","clusterrole-v1alpha1-rbac","watch-list-591","watch-590","list-589","read-588","-strong-read-operations-strong--587","delete-collection-586","delete-585","replace-584","patch-583","create-582","-strong-write-operations-strong--581","clusterrole-v1beta1-rbac","aggregationrule-v1alpha1-rbac","aggregationrule-v1beta1-rbac","-strong-old-api-versions-strong-","weightedpodaffinityterm-v1-core","webhookclientconfig-v1beta1-admissionregistration","webhook-v1beta1-admissionregistration","watchevent-v1-meta","vspherevirtualdiskvolumesource-v1-core","volumeprojection-v1-core","volumemount-v1-core","volumeerror-v1alpha1-storage","volumedevice-v1-core","volumeattachmentsource-v1alpha1-storage","volumeattachment-v1alpha1-storage","validatingwebhookconfiguration-v1beta1-admissionregistration","userinfo-v1-authentication","toleration-v1-core","time-v1-meta","taint-v1-core","tcpsocketaction-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","statefulset-v1-apps","sessionaffinityconfig-v1-core","servicereference-v1beta1-admissionregistration","serviceport-v1-core","serveraddressbyclientcidr-v1-meta","securitycontext-v1-core","secretvolumesource-v1-core","secretreference-v1-core","secretprojection-v1-core","secretkeyselector-v1-core","secretenvsource-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","replicaset-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","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","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","mutatingwebhookconfiguration-v1beta1-admissionregistration","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","fsgroupstrategyoptions-v1beta1-extensions","fcvolumesource-v1-core","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","deployment-v1-apps","deleteoptions-v1-meta","daemonsetupdatestrategy-v1-apps","daemonsetcondition-v1-apps","daemonset-v1-apps","daemonendpoint-v1-core","customresourcevalidation-v1beta1-apiextensions","customresourcedefinitionnames-v1beta1-apiextensions","customresourcedefinitioncondition-v1beta1-apiextensions","crossversionobjectreference-v1-autoscaling","controllerrevision-v1-apps","containerstatewaiting-v1-core","containerstateterminated-v1-core","containerstaterunning-v1-core","containerstate-v1-core","containerport-v1-core","containerimage-v1-core","configmapvolumesource-v1-core","configmapprojection-v1-core","configmapkeyselector-v1-core","configmapenvsource-v1-core","componentcondition-v1-core","clientipconfig-v1-core","cindervolumesource-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-v1beta1-apiregistration","apiresource-v1-meta","apigroup-v1-meta","-strong-definitions-strong-","watch-list-all-namespaces-580","watch-list-579","watch-578","list-all-namespaces-577","list-576","read-575","-strong-read-operations-strong--574","delete-collection-573","delete-572","replace-571","patch-570","create-569","-strong-write-operations-strong--568","networkpolicy-v1-networking","create-567","-strong-write-operations-strong--566","tokenreview-v1-authentication","create-565","-strong-write-operations-strong--564","subjectaccessreview-v1-authorization","watch-list-all-namespaces-563","watch-list-562","watch-561","list-all-namespaces-560","list-559","read-558","-strong-read-operations-strong--557","delete-collection-556","delete-555","replace-554","patch-553","create-552","-strong-write-operations-strong--551","serviceaccount-v1-core","create-550","-strong-write-operations-strong--549","selfsubjectrulesreview-v1-authorization","create-548","-strong-write-operations-strong--547","selfsubjectaccessreview-v1-authorization","watch-list-all-namespaces-546","watch-list-545","watch-544","list-all-namespaces-543","list-542","read-541","-strong-read-operations-strong--540","delete-collection-539","delete-538","replace-537","patch-536","create-535","-strong-write-operations-strong--534","rolebinding-v1-rbac","watch-list-all-namespaces-533","watch-list-532","watch-531","list-all-namespaces-530","list-529","read-528","-strong-read-operations-strong--527","delete-collection-526","delete-525","replace-524","patch-523","create-522","-strong-write-operations-strong--521","role-v1-rbac","replace-status-520","read-status-519","patch-status-518","-strong-status-operations-strong--517","watch-list-all-namespaces-516","watch-list-515","watch-514","list-all-namespaces-513","list-512","read-511","-strong-read-operations-strong--510","delete-collection-509","delete-508","replace-507","patch-506","create-505","-strong-write-operations-strong--504","resourcequota-v1-core","replace-status-503","read-status-502","patch-status-501","-strong-status-operations-strong--500","watch-list-499","watch-498","list-497","read-496","-strong-read-operations-strong--495","delete-collection-494","delete-493","replace-492","patch-491","create-490","-strong-write-operations-strong--489","persistentvolume-v1-core","replace-proxy-path-488","replace-proxy-487","replace-connect-proxy-path-486","replace-connect-proxy-485","head-connect-proxy-path-484","head-connect-proxy-483","get-proxy-path-482","get-proxy-481","get-connect-proxy-path-480","get-connect-proxy-479","delete-proxy-path-478","delete-proxy-477","delete-connect-proxy-path-476","delete-connect-proxy-475","create-proxy-path-474","create-proxy-473","create-connect-proxy-path-472","create-connect-proxy-471","-strong-proxy-operations-strong--470","replace-status-469","read-status-468","patch-status-467","-strong-status-operations-strong--466","watch-list-465","watch-464","list-463","read-462","-strong-read-operations-strong--461","delete-collection-460","delete-459","replace-458","patch-457","create-456","-strong-write-operations-strong--455","node-v1-core","replace-status-454","read-status-453","patch-status-452","-strong-status-operations-strong--451","watch-list-450","watch-449","list-448","read-447","-strong-read-operations-strong--446","delete-445","replace-444","patch-443","create-442","-strong-write-operations-strong--441","namespace-v1-core","create-440","-strong-write-operations-strong--439","localsubjectaccessreview-v1-authorization","list-438","read-437","-strong-read-operations-strong--436","componentstatus-v1-core","watch-list-435","watch-434","list-433","read-432","-strong-read-operations-strong--431","delete-collection-430","delete-429","replace-428","patch-427","create-426","-strong-write-operations-strong--425","clusterrolebinding-v1-rbac","watch-list-424","watch-423","list-422","read-421","-strong-read-operations-strong--420","delete-collection-419","delete-418","replace-417","patch-416","create-415","-strong-write-operations-strong--414","clusterrole-v1-rbac","replace-status-413","-strong-status-operations-strong--412","watch-list-411","watch-410","list-409","read-408","-strong-read-operations-strong--407","delete-collection-406","delete-405","replace-404","patch-403","create-402","-strong-write-operations-strong--401","certificatesigningrequest-v1beta1-certificates","create-400","-strong-write-operations-strong--399","binding-v1-core","replace-status-398","-strong-status-operations-strong--397","watch-list-396","watch-395","list-394","read-393","-strong-read-operations-strong--392","delete-collection-391","delete-390","replace-389","patch-388","create-387","-strong-write-operations-strong--386","apiservice-v1beta1-apiregistration","-strong-cluster-strong-","watch-list-385","watch-384","list-383","read-382","-strong-read-operations-strong--381","delete-collection-380","delete-379","replace-378","patch-377","create-376","-strong-write-operations-strong--375","podsecuritypolicy-v1beta1-extensions","watch-list-all-namespaces-374","watch-list-373","watch-372","list-all-namespaces-371","list-370","read-369","-strong-read-operations-strong--368","delete-collection-367","delete-366","replace-365","patch-364","create-363","-strong-write-operations-strong--362","podpreset-v1alpha1-settings","watch-list-361","watch-360","list-359","read-358","-strong-read-operations-strong--357","delete-collection-356","delete-355","replace-354","patch-353","create-352","-strong-write-operations-strong--351","priorityclass-v1alpha1-scheduling","replace-status-350","read-status-349","patch-status-348","-strong-status-operations-strong--347","watch-list-all-namespaces-346","watch-list-345","watch-344","list-all-namespaces-343","list-342","read-341","-strong-read-operations-strong--340","delete-collection-339","delete-338","replace-337","patch-336","create-335","-strong-write-operations-strong--334","poddisruptionbudget-v1beta1-policy","watch-list-all-namespaces-333","watch-list-332","watch-331","list-all-namespaces-330","list-329","read-328","-strong-read-operations-strong--327","delete-collection-326","delete-325","replace-324","patch-323","create-322","-strong-write-operations-strong--321","podtemplate-v1-core","watch-list-320","watch-319","list-318","read-317","-strong-read-operations-strong--316","delete-collection-315","delete-314","replace-313","patch-312","create-311","-strong-write-operations-strong--310","initializerconfiguration-v1alpha1-admissionregistration","replace-status-309","read-status-308","patch-status-307","-strong-status-operations-strong--306","watch-list-all-namespaces-305","watch-list-304","watch-303","list-all-namespaces-302","list-301","read-300","-strong-read-operations-strong--299","delete-collection-298","delete-297","replace-296","patch-295","create-294","-strong-write-operations-strong--293","horizontalpodautoscaler-v1-autoscaling","watch-list-all-namespaces-292","watch-list-291","watch-290","list-all-namespaces-289","list-288","read-287","-strong-read-operations-strong--286","delete-collection-285","delete-284","replace-283","patch-282","create-281","-strong-write-operations-strong--280","limitrange-v1-core","watch-list-all-namespaces-279","watch-list-278","watch-277","list-all-namespaces-276","list-275","read-274","-strong-read-operations-strong--273","delete-collection-272","delete-271","replace-270","patch-269","create-268","-strong-write-operations-strong--267","event-v1-core","replace-status-266","-strong-status-operations-strong--265","watch-list-264","watch-263","list-262","read-261","-strong-read-operations-strong--260","delete-collection-259","delete-258","replace-257","patch-256","create-255","-strong-write-operations-strong--254","customresourcedefinition-v1beta1-apiextensions","watch-list-all-namespaces-253","watch-list-252","watch-251","list-all-namespaces-250","list-249","read-248","-strong-read-operations-strong--247","delete-collection-246","delete-245","replace-244","patch-243","create-242","-strong-write-operations-strong--241","controllerrevision-v1beta2-apps","-strong-metadata-strong-","volume-v1-core","watch-list-240","watch-239","list-238","read-237","-strong-read-operations-strong--236","delete-collection-235","delete-234","replace-233","patch-232","create-231","-strong-write-operations-strong--230","storageclass-v1-storage","replace-status-229","read-status-228","patch-status-227","-strong-status-operations-strong--226","watch-list-all-namespaces-225","watch-list-224","watch-223","list-all-namespaces-222","list-221","read-220","-strong-read-operations-strong--219","delete-collection-218","delete-217","replace-216","patch-215","create-214","-strong-write-operations-strong--213","persistentvolumeclaim-v1-core","watch-list-all-namespaces-212","watch-list-211","watch-210","list-all-namespaces-209","list-208","read-207","-strong-read-operations-strong--206","delete-collection-205","delete-204","replace-203","patch-202","create-201","-strong-write-operations-strong--200","secret-v1-core","watch-list-all-namespaces-199","watch-list-198","watch-197","list-all-namespaces-196","list-195","read-194","-strong-read-operations-strong--193","delete-collection-192","delete-191","replace-190","patch-189","create-188","-strong-write-operations-strong--187","configmap-v1-core","-strong-config-storage-strong-","replace-proxy-path-186","replace-proxy-185","replace-connect-proxy-path-184","replace-connect-proxy-183","head-connect-proxy-path-182","head-connect-proxy-181","get-proxy-path-180","get-proxy-179","get-connect-proxy-path-178","get-connect-proxy-177","delete-proxy-path-176","delete-proxy-175","delete-connect-proxy-path-174","delete-connect-proxy-173","create-proxy-path-172","create-proxy-171","create-connect-proxy-path-170","create-connect-proxy-169","-strong-proxy-operations-strong--168","replace-status-167","read-status-166","patch-status-165","-strong-status-operations-strong--164","watch-list-all-namespaces-163","watch-list-162","watch-161","list-all-namespaces-160","list-159","read-158","-strong-read-operations-strong--157","delete-156","replace-155","patch-154","create-153","-strong-write-operations-strong--152","service-v1-core","replace-status-151","read-status-150","patch-status-149","-strong-status-operations-strong--148","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","ingress-v1beta1-extensions","watch-list-all-namespaces-134","watch-list-133","watch-132","list-all-namespaces-131","list-130","read-129","-strong-read-operations-strong--128","delete-collection-127","delete-126","replace-125","patch-124","create-123","-strong-write-operations-strong--122","endpoints-v1-core","-strong-discovery-load-balancing-strong-","replace-status-121","read-status-120","patch-status-119","-strong-status-operations-strong--118","watch-list-all-namespaces-117","watch-list-116","watch-115","list-all-namespaces-114","list-113","read-112","-strong-read-operations-strong--111","delete-collection-110","delete-109","replace-108","patch-107","create-106","-strong-write-operations-strong--105","statefulset-v1beta2-apps","replace-status-104","read-status-103","patch-status-102","-strong-status-operations-strong--101","watch-list-all-namespaces-100","watch-list-99","watch-98","list-all-namespaces-97","list-96","read-95","-strong-read-operations-strong--94","delete-collection-93","delete-92","replace-91","patch-90","create-89","-strong-write-operations-strong--88","replicationcontroller-v1-core","replace-status-87","read-status-86","patch-status-85","-strong-status-operations-strong--84","watch-list-all-namespaces-83","watch-list-82","watch-81","list-all-namespaces-80","list-79","read-78","-strong-read-operations-strong--77","delete-collection-76","delete-75","replace-74","patch-73","create-72","-strong-write-operations-strong--71","replicaset-v1beta2-apps","read-log","-strong-misc-operations-strong-","replace-proxy-path","replace-proxy","replace-connect-proxy-path","replace-connect-proxy","head-connect-proxy-path","head-connect-proxy","get-proxy-path","get-proxy","get-connect-proxy-path","get-connect-proxy","get-connect-portforward","delete-proxy-path","delete-proxy","delete-connect-proxy-path","delete-connect-proxy","create-proxy-path","create-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-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","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-v1beta2-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-v1beta2-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/docs/api-reference/v1.9/node_modules/bootstrap/dist/css/bootstrap.min.css b/docs/api-reference/v1.9/node_modules/bootstrap/dist/css/bootstrap.min.css deleted file mode 100644 index ed3905e0e0c91..0000000000000 --- a/docs/api-reference/v1.9/node_modules/bootstrap/dist/css/bootstrap.min.css +++ /dev/null @@ -1,6 +0,0 @@ -/*! - * 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/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.css b/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.css deleted file mode 100644 index ee906a8196d0f..0000000000000 --- a/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.css +++ /dev/null @@ -1,2337 +0,0 @@ -/*! - * 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/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.css.map b/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.css.map deleted file mode 100644 index 60763a8640f1c..0000000000000 --- a/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.css.map +++ /dev/null @@ -1,7 +0,0 @@ -{ -"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/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.min.css b/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.min.css deleted file mode 100644 index 540440ce89f2a..0000000000000 --- a/docs/api-reference/v1.9/node_modules/font-awesome/css/font-awesome.min.css +++ /dev/null @@ -1,4 +0,0 @@ -/*! - * 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/docs/api-reference/v1.9/node_modules/font-awesome/fonts/FontAwesome.otf b/docs/api-reference/v1.9/node_modules/font-awesome/fonts/FontAwesome.otf deleted file mode 100644 index 401ec0f36e4f7..0000000000000 Binary files a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/FontAwesome.otf and /dev/null differ diff --git a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.eot b/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca953f93..0000000000000 Binary files a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.svg b/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845e538b6..0000000000000 --- a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.ttf b/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2fa1196..0000000000000 Binary files a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.woff b/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a4b06ee..0000000000000 Binary files a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 b/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc60404b9..0000000000000 Binary files a/docs/api-reference/v1.9/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/docs/api-reference/v1.9/node_modules/highlight.js/styles/default.css b/docs/api-reference/v1.9/node_modules/highlight.js/styles/default.css deleted file mode 100644 index f1bfade31e5dc..0000000000000 --- a/docs/api-reference/v1.9/node_modules/highlight.js/styles/default.css +++ /dev/null @@ -1,99 +0,0 @@ -/* - -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/docs/api-reference/v1.9/node_modules/jquery.scrollto/jquery.scrollTo.min.js b/docs/api-reference/v1.9/node_modules/jquery.scrollto/jquery.scrollTo.min.js deleted file mode 100644 index 65a020d92ad28..0000000000000 --- a/docs/api-reference/v1.9/node_modules/jquery.scrollto/jquery.scrollTo.min.js +++ /dev/null @@ -1,7 +0,0 @@ -/** - * 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(" - +
diff --git a/docs/user-guide/walkthrough/OWNERS b/docs/user-guide/walkthrough/OWNERS index 225d2b4509b3d..cc182504e9193 100644 --- a/docs/user-guide/walkthrough/OWNERS +++ b/docs/user-guide/walkthrough/OWNERS @@ -1,4 +1,4 @@ -approvers: +reviewers: - eparis - janetkuo - mikedanese diff --git a/docs/user-guide/walkthrough/deployment-update.yaml b/docs/user-guide/walkthrough/deployment-update.yaml index 8f0ac0b48c682..14a7dc473b0d5 100644 --- a/docs/user-guide/walkthrough/deployment-update.yaml +++ b/docs/user-guide/walkthrough/deployment-update.yaml @@ -1,8 +1,11 @@ -apiVersion: apps/v1beta1 +apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment spec: + selector: + matchLabels: + app: nginx replicas: 2 template: metadata: diff --git a/docs/user-guide/walkthrough/deployment.yaml b/docs/user-guide/walkthrough/deployment.yaml index 8d14e2ef08a82..485be0dabcdf2 100644 --- a/docs/user-guide/walkthrough/deployment.yaml +++ b/docs/user-guide/walkthrough/deployment.yaml @@ -1,8 +1,11 @@ -apiVersion: apps/v1beta1 +apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment spec: + selector: + matchLabels: + app: nginx replicas: 2 # tells deployment to run 2 pods matching the template template: # create pods using pod definition in this template metadata: diff --git a/docs/user-guide/walkthrough/index.md b/docs/user-guide/walkthrough/index.md index 20fd482271e76..a2123d54fb858 100644 --- a/docs/user-guide/walkthrough/index.md +++ b/docs/user-guide/walkthrough/index.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - eparis - mikedanese title: Kubernetes 101 diff --git a/docs/user-guide/walkthrough/k8s201.md b/docs/user-guide/walkthrough/k8s201.md index 2be84046ff885..8774b718f442b 100644 --- a/docs/user-guide/walkthrough/k8s201.md +++ b/docs/user-guide/walkthrough/k8s201.md @@ -1,5 +1,5 @@ --- -approvers: +reviewers: - janetkuo - mikedanese title: Kubernetes 201 @@ -37,7 +37,7 @@ For example, here is the nginx Pod definition with labels ([pod-nginx-with-label Create the labeled Pod ([pod-nginx-with-label.yaml](/docs/user-guide/walkthrough/pod-nginx-with-label.yaml)): ```shell -kubectl create -f docs/user-guide/walkthrough/pod-nginx-with-label.yaml +kubectl create -f https://k8s.io/docs/user-guide/walkthrough/pod-nginx-with-label.yaml ``` List all Pods with the label `app=nginx`: @@ -46,6 +46,12 @@ List all Pods with the label `app=nginx`: kubectl get pods -l app=nginx ``` +Delete the Pod by label: + +```shell +kubectl delete pod -l app=nginx +``` + For more information, see [Labels](/docs/concepts/overview/working-with-objects/labels/). They are a core concept used by two additional Kubernetes building blocks: Deployments and Services. @@ -67,10 +73,8 @@ Here is a Deployment that instantiates two nginx Pods: Create an nginx Deployment: -Download the `deployment.yaml` above by clicking on the file name and copy to your local directory. - ```shell -kubectl create -f ./deployment.yaml +kubectl create -f https://k8s.io/docs/user-guide/walkthrough/deployment.yaml ``` List all Deployments: @@ -90,10 +94,8 @@ contains the desired changes: {% include code.html language="yaml" file="deployment-update.yaml" ghlink="/docs/user-guide/walkthrough/deployment-update.yaml" %} -Download ./deployment-update.yaml and copy to your local directory. - ```shell -kubectl apply -f ./deployment-update.yaml +kubectl apply -f https://k8s.io/docs/user-guide/walkthrough//deployment-update.yaml ``` Watch the Deployment create Pods with new names and delete the old Pods: @@ -125,7 +127,7 @@ For example, here is a service that balances across the Pods created in the prev Create an nginx service ([service.yaml](/docs/user-guide/walkthrough/service.yaml)): ```shell -kubectl create -f docs/user-guide/walkthrough/service.yaml +kubectl create -f https://k8s.io/docs/user-guide/walkthrough/service.yaml ``` List all services: @@ -150,6 +152,14 @@ $ kubectl delete pod busybox # Clean up the pod we created with "kubectl run" {% endraw %} ``` +The service definition [exposed the Nginx Service](/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/) as port 8000 (`$SERVCE_PORT`). We can also access the service from a host running Kubernetes using that port: + +```shell +wget -qO- http://$SERVICE_IP:$SERVICE_PORT # Run on a Kubernetes host +``` + +(This works on AWS with Weave.) + To delete the service by name: ```shell diff --git a/docs/user-journeys/users/application-developer/advanced.md b/docs/user-journeys/users/application-developer/advanced.md new file mode 100644 index 0000000000000..401de698dcf87 --- /dev/null +++ b/docs/user-journeys/users/application-developer/advanced.md @@ -0,0 +1,117 @@ +--- +reviewers: +- chenopis +layout: docsportal +css: /css/style_user_journeys.css, https://fonts.googleapis.com/icon?family=Material+Icons +js: https://use.fontawesome.com/4bcc658a89.js, https://cdnjs.cloudflare.com/ajax/libs/prefixfree/1.0.7/prefixfree.min.js +title: Advanced Topics +track: "USERS › APPLICATION DEVELOPER › ADVANCED" +--- + +{% capture overview %} + +{: .note } +This page assumes that you're familiar with core Kubernetes concepts, and are comfortable deploying your own apps. If not, you should review the [Intermediate App Developer](/docs/user-journeys/users/application-developer/intermediate/){:target="_blank"} topics first. + +After checking out the current page and its linked sections, you should have a better understanding of the following: +* Advanced features that you can leverage in your application +* The various ways of extending the Kubernetes API + +{% endcapture %} + + +{% capture body %} + +## Deploy an application with advanced features + +Now you know the set of API objects that Kubernetes provides. Understanding the difference between a {% glossary_tooltip term_id="daemonset" %} and a {% glossary_tooltip term_id="deployment" %} is oftentimes sufficient for app deployment. That being said, it's also worth familiarizing yourself with Kubernetes's lesser known features. They can be quite powerful when applied to the right use cases. + +#### Container-level features + +As you may know, it's an antipattern to migrate an entire app (e.g. containerized Rails app, MySQL database, and all) into a single Pod. That being said, there are some very useful patterns that go beyond a 1:1 correspondence between a container and its Pod: +* **Sidecar container**: Although your Pod should still have a single main container, you can add a secondary container that acts as a helper (see a [logging example](/docs/concepts/cluster-administration/logging/#sidecar-container-with-a-logging-agent){:target="_blank"}). Two containers within a single Pod can communicate [via a shared volume](/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume/){:target="_blank"}. +* **Init containers**: *Init containers* run before any of a Pod's *app containers* (such as main and sidecar containers). [Read more](/docs/concepts/workloads/pods/init-containers/){:target="_blank"}, see an [nginx server example](/docs/tasks/configure-pod-container/configure-pod-initialization/){:target="_blank"}, and [learn how to debug these containers](/docs/tasks/debug-application-cluster/debug-init-containers/){:target="_blank"}. + +#### Pod configuration + +Usually, you use {% glossary_tooltip text="labels" term_id="label" %} and {% glossary_tooltip text="annotations" term_id="annotation" %} to attach metadata to your resources. To inject data into your resources, you'd likely create {% glossary_tooltip text="ConfigMaps" term_id="configmap" %} (for nonconfidential data) or {% glossary_tooltip text="Secrets" term_id="secret" %} (for confidential data). + +Below are some other, lesser-known ways of configuring your resources' Pods: + +* **Taints and Tolerations** - These provide a way for nodes to "attract" or "repel" your Pods. They are often used when an application needs to be deployed onto specific hardware, such as GPUs for scientific computing. [Read more](/docs/concepts/configuration/taint-and-toleration/){:target="_blank"}. +* **Downward API** - This allows your containers to consume information about themselves or the cluster, without being overly coupled to the Kubernetes API server. This can be achieved with [environment variables](/docs/tasks/inject-data-application/environment-variable-expose-pod-information/){:target="_blank"} or [DownwardAPIVolumeFiles](/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/){:target="_blank"}. +* **Pod Presets** - Normally, to mount runtime requirements (such as environmental variables, ConfigMaps, and Secrets) into a resource, you specify them in the resource's configuration file. [PodPresets](/docs/concepts/workloads/pods/podpreset/){:target="_blank"} allow you to dynamically inject these requirements instead, when the resource is created. For instance, this allows team A to mount any number of new Secrets into the resources created by teams B and C, without requiring action from B and C. [See an example](/docs/tasks/inject-data-application/podpreset/){:target="_blank"}. + +#### Additional API Objects + +{: .note } +Before setting up the following resources, check to see if they are the responsibility of your organization's {% glossary_tooltip text="cluster operators" term_id="cluster-operator" %}. + +* **{% glossary_tooltip text="Horizontal Pod Autoscaler (HPA)" term_id="horizontal-pod-autoscaler" %}** - These resources are a great way to automate the process of scaling your application when CPU usage or other [custom metrics](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/instrumentation/custom-metrics-api.md){:target="_blank"} spike. [See an example](/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/){:target="_blank"} to understand how HPAs are set up. + +* **Federated cluster objects** - If you are running an application on multiple Kubernetes clusters using *federation*, you need to deploy the federated version of the standard Kubernetes API objects. For reference, check out the guides for setting up [Federated ConfigMaps](/docs/tasks/administer-federation/configmap/){:target="_blank"} and [Federated Deployments](/docs/tasks/administer-federation/deployment/){:target="_blank"}. + +## Extend the Kubernetes API + +Kubernetes is designed with extensibility in mind. If the API resources and features mentioned above are not enough for your needs, there are ways to customize its behavior without having to modify core Kubernetes code. + +#### Understand Kubernetes's default behavior + +Before making any customizations, it's important that you understand the general abstraction behind Kubernetes API objects. Although Deployments and Secrets may seem quite different, the following concepts are true for *any* object: + +* **Kubernetes objects are a way of storing structured data about your cluster.** + In the case of Deployments, this data represents desired state (such as "How many replicas should be running?"), but it can also be general metadata (such as database credentials). +* **Kubernetes objects are modified via the {% glossary_tooltip text="Kubernetes API" term_id="kubernetes-api" %}**. + In other words, you can make `GET` and `POST` requests to a specific resource path (such as `/api/v1/namespaces/default/deployments`) to read and write the corresponding object type. +* **By leveraging the [Controller pattern](/docs/concepts/api-extension/custom-resources/#custom-controllers){:target="_blank"}, Kubernetes objects can be used to enforce desired state**. For simplicity, you can think of the Controller pattern as the following continuous loop: + +
+ 1. Check current state (number of replicas, container image, etc) + 2. Compare current state to desired state + 3. Update if there's a mismatch +
+ + These states are obtained from the Kubernetes API. + + {: .note } + Not all Kubernetes objects need to have a Controller. Though Deployments trigger the cluster to make state changes, ConfigMaps act purely as storage. + +#### Create Custom Resources + +Based on the ideas above, you can define a new [Custom Resource](/docs/concepts/api-extension/custom-resources/#custom-resources){:target="_blank"} that is just as legitimate as a Deployment. For example, you might want to define a `Backup` object for periodic backups, if `CronJobs` don't provide all the functionality you need. + +There are two main ways of setting up custom resources: +1. **Custom Resource Definitions (CRDs)** - This method requires the least amount of implementation work. See [an example](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/){:target="_blank"}. +2. **API aggregation** - This method requires some [pre-configuration](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/){:target="_blank"} before you actually [set up a separate, extension API server](/docs/tasks/access-kubernetes-api/setup-extension-api-server/){:target="_blank"}. + +Note that unlike standard Kubernetes objects, which rely on the built-in [`kube-controller-manager`](/docs/reference/generated/kube-controller-manager/){:target="_blank"}, you'll need to write and run your own [custom controllers](https://github.com/kubernetes/sample-controller){:target="_blank"}. + +You may also find the following info helpful: +* [How to know if custom resources are right for your use case](/docs/concepts/api-extension/custom-resources/#should-i-use-a-configmap-or-a-custom-resource){:target="_blank"} +* [How to decide between CRDs and API aggregation](/docs/concepts/api-extension/custom-resources/#choosing-a-method-for-adding-custom-resources){:target="_blank"} + +#### Service Catalog + +If you want to consume or provide complete services (rather than individual resources), **{% glossary_tooltip text="Service Catalog" term_id="service-catalog" %}** provides a [specification](https://github.com/openservicebrokerapi/servicebroker){:target="_blank"} for doing so. These services are registered using {% glossary_tooltip text="Service Brokers" term_id="service-broker" %} (see [some examples](https://github.com/openservicebrokerapi/servicebroker/blob/master/gettingStarted.md#example-service-brokers){:target="_blank"}). + +If you do not have a {% glossary_tooltip text="cluster operator" term_id="cluster-operator" %} to manage the installation of Service Catalog, you can do so using [Helm](/docs/tasks/service-catalog/install-service-catalog-using-helm/){:target="_blank"} or an [installer binary](/docs/tasks/service-catalog/install-service-catalog-using-sc/){:target="_blank"}. + + +## Explore additional resources + +#### References + +The following topics are also useful for building more complex applications: +* [Other points of extensibility within Kubernetes](/docs/concepts/overview/extending/){:target="_blank"} - A conceptual overview of where you can hook into the Kubernetes architecture. +* [Kubernetes Client Libraries](/docs/reference/client-libraries/){:target="_blank"} - Useful for building apps that need to interact heavily with the Kubernetes API. + +#### What's next +Congrats on completing the Application Developer user journey! You've covered the majority of features that Kubernetes has to offer. What now? + +* If you'd like to suggest new features or keep up with the latest developments around Kubernetes app development, consider joining a {% glossary_tooltip term_id="sig" %} such as [SIG Apps](https://github.com/kubernetes/community/tree/master/sig-apps){:target="_blank"}. + +* If you are interested in learning more about the inner workings of Kubernetes (e.g. networking), consider checking out the [Cluster Operator journey](/docs/user-journeys/users/cluster-operator/foundational/){:target="_blank"}. + +{% endcapture %} + +{% include templates/user-journey-content.md %} diff --git a/docs/user-journeys/users/application-developer/foundational.md b/docs/user-journeys/users/application-developer/foundational.md new file mode 100644 index 0000000000000..fd18b2c9fc150 --- /dev/null +++ b/docs/user-journeys/users/application-developer/foundational.md @@ -0,0 +1,232 @@ +--- +reviewers: +- chenopis +layout: docsportal +css: /css/style_user_journeys.css, https://fonts.googleapis.com/icon?family=Material+Icons +js: https://use.fontawesome.com/4bcc658a89.js, https://cdnjs.cloudflare.com/ajax/libs/prefixfree/1.0.7/prefixfree.min.js +title: Foundational +track: "USERS › APPLICATION DEVELOPER › FOUNDATIONAL" +--- + +{% capture overview %} +If you're a developer looking to run applications on Kubernetes, this page and its linked topics can help you get started with the fundamentals. Though this page primarily describes development workflows, [the subsequent page in the series](/docs/home/?path=users&persona=app-developer&level=intermediate){:target="_blank"} covers more advanced, production setups. + +{: .note } +**A quick note**
This app developer "user journey" is *not* a comprehensive overview of Kubernetes. It focuses more on *what* you develop, test, and deploy to Kubernetes, rather than *how* the underlying infrastructure works.

Though it's possible for a single person to manage both, in many organizations, it’s common to assign the latter to a dedicated {% glossary_tooltip text="cluster operator" term_id="cluster-operator" %}. + +{% endcapture %} + + +{% capture body %} +## Get started with a cluster + +#### Web-based environment + +If you're brand new to Kubernetes and simply want to experiment without setting up a full development environment, *web-based environments* are a good place to start: + +* [Kubernetes Basics](/docs/tutorials/kubernetes-basics/#basics-modules){:target="_blank"} - Introduces you to six common Kubernetes workflows. Each section walks you through browser-based, interactive exercises complete with their own Kubernetes environment. + +* [Katacoda](https://www.katacoda.com/courses/kubernetes/playground){:target="_blank"} - The playground equivalent of the environment used in *Kubernetes Basics* above. Katacoda also provides [more advanced tutorials](https://www.katacoda.com/courses/kubernetes/){:target="_blank"}, such as "Liveness and Readiness Healthchecks". + + +* [Play with Kubernetes](http://labs.play-with-k8s.com/){:target="_blank"} - A less structured environment than the *Katacoda* playground, for those who are more comfortable with Kubernetes concepts and want to explore further. It supports the ability to spin up multiple nodes. + + +#### Minikube (recommended) + +Web-based environments are easy to access, but are not persistent. If you want to continue exploring Kubernetes in a workspace that you can come back to and change, *Minikube* is a good option. + +Minikube can be installed locally, and runs a simple, single-node Kubernetes cluster inside a virtual machine (VM). This cluster is fully functioning and contains all core Kubernetes components. Many developers have found this sufficient for local application development. + +* [Install Minikube](/docs/tasks/tools/install-minikube/){:target="_blank"}. + +* [Install kubectl](/docs/tasks/tools/install-kubectl/){:target="_blank"}. ({% glossary_tooltip text="What is kubectl?" term_id="kubectl" %}) + +* *(Optional)* [Install Docker](/docs/setup/independent/install-kubeadm/#installing-docker){:target="_blank"} if you plan to run your Minikube cluster as part of a local development environment. + + Minikube includes a Docker daemon, but if you're developing applications locally, you'll want an independent Docker instance to support your workflow. This allows you to create {% glossary_tooltip text="containers" term_id="container" %} and push them to a container registry. + + {: .note } + Version 1.12 is recommended for full compatibility with Kubernetes, but a few other versions are tested and known to work. + + +You can get basic information about your cluster with the commands `kubectl cluster-info` and `kubectl get nodes`. However, to get a good idea of what's really going on, you need to deploy an application to your cluster. This is covered in the next section. + +## Deploy an application + +#### Basic workloads + +The following examples demonstrate the fundamentals of deploying Kubernetes apps: + * **Stateless apps**: [Deploy a simple nginx server](/docs/tasks/run-application/run-stateless-application-deployment/){:target="_blank"}. + + * **Stateful apps**: [Deploy a MySQL database](/docs/tasks/run-application/run-single-instance-stateful-application/){:target="_blank"}. + +Through these deployment tasks, you'll gain familiarity with the following: +* General concepts + + * **Configuration files** - Written in YAML or JSON, these files describe the desired state of your application in terms of Kubernetes API objects. A file can include one or more API object descriptions (*manifests*). (See [the example YAML](/docs/tasks/run-application/run-stateless-application-deployment/#creating-and-exploring-an-nginx-deployment) from the stateless app). + + * **{% glossary_tooltip text="Pods" term_id="pod" %}** - This is the basic unit for all of the workloads you run on Kubernetes. These workloads, such as *Deployments* and *Jobs*, are composed of one or more Pods. To learn more, check out [this explanation of Pods and Nodes](/docs/tutorials/kubernetes-basics/explore-intro/){:target="_blank"}. + +* Common workload objects + * **{% glossary_tooltip text="Deployment" term_id="deployment" %}** - The most common way of running *X* copies (Pods) of your application. Supports rolling updates to your container images. + + * **{% glossary_tooltip text="Service" term_id="deployment" %}** - By itself, a Deployment can't receive traffic. Setting up a Service is one of the simplest ways to configure a Deployment to receive and loadbalance requests. Depending on the `type` of Service used, these requests can come from external client apps or be limited to apps within the same cluster. A Service is tied to a specific Deployment using {% glossary_tooltip text="label" term_id="label" %} selection. + +The subsequent topics are also useful to know for basic application deployment. + +#### Metadata + +You can also specify custom information about your Kubernetes API objects by attaching key/value fields. Kubernetes provides two ways of doing this: + +* **{% glossary_tooltip text="Labels" term_id="label" %}** - Identifying metadata that you can use to sort and select sets of API objects. Labels have many applications, including the following: + + * *To keep the right number of replicas (Pods) running in a Deployment.* The specified label (`app: nginx` in the [stateless app example](/docs/tasks/run-application/run-stateless-application-deployment/#creating-and-exploring-an-nginx-deployment){:target="_blank"}) is used to stamp the Deployment's newly created Pods (as the value of the `spec.template.labels` configuration field), and to query which Pods it already manages (as the value of `spec.selector.matchLabels`). + + * *To tie a Service to a Deployment* using the `selector` field, which is demonstrated in the [stateful app example](/docs/tasks/run-application/run-single-instance-stateful-application/#deploy-mysql){:target="_blank"}. + + * *To look for specific subset of Kubernetes objects, when you are using {% glossary_tooltip text="kubectl" term_id="kubectl" %}.* For instance, the command `kubectl get deployments --selector=app=nginx` only displays Deployments from the nginx app. + +* **{% glossary_tooltip text="Annotations" term_id="annotation" %}** - Nonidentifying metadata that you can attach to API objects, usually if you don't intend to use them for sorting purposes. These often serve as supplementary data about an app's deployment, such as Git SHAs, PR numbers, or URL pointers to observability dashboards. + + +#### Storage + +You'll also want to think about storage. Kubernetes provides different types of storage API objects for different storage needs: + +* **{% glossary_tooltip text="Volumes" term_id="volume" %}** - Let you define storage for your cluster that is tied to the lifecycle of a Pod. It is therefore more persistent than container storage. Learn [how to configure volume storage](/docs/tasks/configure-pod-container/configure-volume-storage/){:target="_blank"}, or [read more about volume storage](/docs/concepts/storage/volumes/){:target="_blank"}. + +* **{% glossary_tooltip text="PersistentVolumes" term_id="persistent-volume" %}** and **{% glossary_tooltip text="PersistentVolumeClaims" term_id="persistent-volume-claim" %}** - Let you define storage at the cluster level. Typically a cluster operator defines the PersistentVolume objects for the cluster, and cluster users (application developers, you) define the PersistentVolumeClaim objects that your application requires. Learn [how to set up persistent storage for your cluster](/docs/tasks/configure-pod-container/configure-persistent-volume-storage/){:target="_blank"} or [read more about persistent volumes](/docs/concepts/storage/persistent-volumes/){:target="_blank"}. + +#### Configuration + +To avoid having to unnecessarily rebuild your container images, you should decouple your application's *configuration data* from the code required to run it. There are a couple ways of doing this, which you should choose according to your use case: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ApproachType of DataHow it's mountedExample
Using a manifest's container definitionNon-confidentialEnvironment variableCommand-line flag
Using {% glossary_tooltip text="ConfigMaps" term_id="configmap" %}Non-confidentialEnvironment variable OR local filenginx configuration
Using {% glossary_tooltip text="Secrets" term_id="secret" %}ConfidentialEnvironment variable OR local fileDatabase credentials
+ +{: .note } +If you have any data that you want to keep private, you should be using a Secret. Otherwise there is nothing stopping that data from being exposed to malicious users. + +## Understand basic Kubernetes architecture + +As an app developer, you don't need to know everything about the inner workings of Kubernetes, but you may find it helpful to understand it at a high level. + +#### What Kubernetes offers + +Say that your team is deploying an ordinary Rails application. You've run some calculations and determined that you need five instances of your app running at any given time, in order to handle external traffic. + +If you're not running Kubernetes or a similar automated system, you might find the following scenario familiar: + +
+ +1. One instance of your app (a complete machine instance or just a container) goes down. +2. Because your team has monitoring set up, this pages the person on call. +3. The on-call person has to go in, investigate, and manually spin up a new instance. +4. Depending how your team handles DNS/networking, the on-call person may also need to also update the service discovery mechanism to point at the IP of the new Rails instance rather than the old. + +
+ +This process can be tedious and also inconvenient, especially if (2) happens in the early hours of the morning! + +**If you have Kubernetes set up, however, manual intervention is not as necessary.** The Kubernetes [control plane](/docs/concepts/overview/components/#master-components){:target="_blank"}, which runs on your cluster's master node, gracefully handles (3) and (4) on your behalf. As a result, Kubernetes is often referred to as a *self-healing* system. + +There are two key parts of the control plane that facilitate this behavior: the *Kubernetes API server* and the *Controllers*. + +#### Kubernetes API server + +For Kubernetes to be useful, it needs to know *what* sort of cluster state you want it to maintain. Your YAML or JSON *configuration files* declare this desired state in terms of one or more API objects, such as {% glossary_tooltip text="Deployments" term_id="deployment" %}. To make updates to your cluster's state, you submit these files to the {% glossary_tooltip text="Kubernetes API" term_id="kubernetes-api" %} server (`kube-apiserver`). + +Examples of state include but are not limited to the following: + +* The applications or other workloads to run +* The container images for your applications and workloads +* Allocation of network and disk resources + +Note that the API server is just the gateway, and that object data is actually stored in a highly available datastore called [*etcd*](https://github.com/coreos/etcd){:target="_blank"}. For most intents and purposes, though, you can focus on the API server. Most reads and writes to cluster state take place as API requests. + +You can read more about the Kubernetes API [here](/docs/concepts/overview/working-with-objects/kubernetes-objects/){:target="_blank"}. + +#### Controllers + +Once you’ve declared your desired state through the Kubernetes API, the *controllers* work to make the cluster’s current state match this desired state. + +The standard controller processes are [`kube-controller-manager`](/docs/reference/generated/kube-controller-manager/){:target="_blank"} and [`cloud-controller-manager`](/docs/concepts/overview/components/#cloud-controller-manager){:target="_blank"}, but you can also write your own controllers as well. + +All of these controllers implement a *control loop*. For simplicity, you can think of this as the following: + +
+ 1. What is the current state of the cluster (X)? + 2. What is the desired state of the cluster (Y)? + 3. X == Y ? + * `true` - Do nothing. + * `false` - Perform tasks to get to Y (such as starting or restarting containers, +or scaling the number of replicas of a given application).
+ + *(Return to 1)* +
+ +By continuously looping, these controllers ensure the cluster can pick up new updates and avoid drifting from the desired state. These ideas are covered in more detail [here](https://kubernetes.io/docs/concepts/){:target="_blank"}. + +## Additional resources + +The Kubernetes documentation is rich in detail. Here's a curated list of resources to help you start digging deeper. + +### Basic concepts + +* [More about the components that run Kubernetes](/docs/concepts/overview/components/){:target="_blank"} + +* [Understanding Kubernetes objects](/docs/concepts/overview/working-with-objects/kubernetes-objects/){:target="_blank"} + +* [More about Node objects](/docs/concepts/architecture/nodes/){:target="_blank"} + +* [More about Pod objects](/docs/concepts/workloads/pods/pod-overview/){:target="_blank"} + +### Tutorials + +* [Kubernetes Basics](/docs/tutorials/kubernetes-basics/){:target="_blank"} + +* [Hello Minikube](/docs/tutorials/stateless-application/hello-minikube/){:target="_blank"} *(Runs on Mac only)* + +* [Kubernetes 101](/docs/user-guide/walkthrough/){:target="_blank"} + +* [Kubernetes 201](/docs/user-guide/walkthrough/k8s201/){:target="_blank"} + +* [Kubernetes object management](/docs/tutorials/object-management-kubectl/object-management/){:target="_blank"} + +### What's next +If you feel fairly comfortable with the topics on this page and want to learn more, check out the following user journeys: +* [Intermediate App Developer](/docs/user-journeys/users/application-developer/intermediate/){:target="_blank"} - Dive deeper, with the next level of this journey. +* [Foundational Cluster Operator](/docs/user-journeys/users/cluster-operator/foundational/){:target="_blank"} - Build breadth, by exploring other journeys. + +{% endcapture %} + + +{% include templates/user-journey-content.md %} diff --git a/docs/user-journeys/users/application-developer/intermediate.md b/docs/user-journeys/users/application-developer/intermediate.md new file mode 100644 index 0000000000000..6168031f8eaf4 --- /dev/null +++ b/docs/user-journeys/users/application-developer/intermediate.md @@ -0,0 +1,157 @@ +--- +reviewers: +- chenopis +layout: docsportal +css: /css/style_user_journeys.css, https://fonts.googleapis.com/icon?family=Material+Icons +js: https://use.fontawesome.com/4bcc658a89.js, https://cdnjs.cloudflare.com/ajax/libs/prefixfree/1.0.7/prefixfree.min.js +title: Intermediate +track: "USERS › APPLICATION DEVELOPER › INTERMEDIATE" +--- +{% assign reference_docs_url = '/docs/reference/generated/kubernetes-api/' | append: site.latest %} + +{% capture overview %} + +{: .note } + This page assumes that you've experimented with Kubernetes before. At this point, you should have basic experience interacting with a Kubernetes cluster (locally with Minikube, or elsewhere), and using API objects like Deployments to run your applications.

If not, you should review the [Beginner App Developer](/docs/user-journeys/users/application-developer/foundational/){:target="_blank"} topics first. + +After checking out the current page and its linked sections, you should have a better understanding of the following: +* Additional Kubernetes workload patterns, beyond Deployments +* What it takes to make a Kubernetes application production-ready +* Community tools that can improve your development workflow + +{% endcapture %} + + +{% capture body %} + +## Learn additional workload patterns + +As your Kubernetes use cases become more complex, you may find it helpful to familiarize yourself with more of the toolkit that Kubernetes provides. [Basic workload](/docs/user-journeys/users/application-developer/foundational/#section-2){:target="_blank"} objects like {% glossary_tooltip text="Deployments" term_id="deployment" %} make it straightforward to run, update, and scale applications, but they are not ideal for every scenario. + +The following API objects provide functionality for additional workload types, whether they are *persistent* or *terminating*. + +#### Persistent workloads + +Like Deployments, these API objects run indefinitely on a cluster until they are manually terminated. They are best for long-running applications. + +* **{% glossary_tooltip text="StatefulSets" term_id="statefulset" %}** - Like Deployments, StatefulSets allow you to specify that a certain number of replicas should be running for your application. + + {: .note } + It's misleading to say that Deployments can't handle stateful workloads. Using {% glossary_tooltip text="PersistentVolumes" term_id="persistent-volume" %}, you can persist data beyond the lifecycle of any individual Pod in your Deployment. + + However, StatefulSets can provide stronger guarantees about "recovery" behavior than Deployments. StatefulSets maintain a sticky, stable identity for their Pods. The following table provides some concrete examples of what this might look like: + + | | Deployment | StatefulSet | + |---|---|---| + | **Example Pod name** | `example-b1c4` | `example-0` | + | **When a Pod dies** | Reschedule on *any* node, with new name `example-a51z` | Reschedule on same node, as `example-0` | + | **When a node becomes unreachable** | Pod(s) are scheduled onto new node, with new names | Pod(s) are marked as "Unknown", and aren't rescheduled unless the Node object is forcefully deleted | + + In practice, this means that StatefulSets are best suited for scenarios where replicas (Pods) need to coordinate their workloads in a strongly consistent manner. Guaranteeing an identity for each Pod helps avoid [split-brain](https://en.wikipedia.org/wiki/Split-brain_(computing)){:target="_blank"} side effects in the case when a node becomes unreachable ([network partition](https://en.wikipedia.org/wiki/Network_partition){:target="_blank"}). This makes StatefulSets a great fit for distributed datastores like Cassandra or Elasticsearch. + + +* **{% glossary_tooltip text="DaemonSets" term_id="daemonset" %}** - DaemonSets run continuously on every node in your cluster, even as nodes are added or swapped in. This guarantee is particularly useful for setting up global behavior across your cluster, such as: + + * Logging and monitoring, from applications like `fluentd` + * Network proxy or [service mesh](https://www.linux.com/news/whats-service-mesh-and-why-do-i-need-one){:target="_blank"} + + +#### Terminating workloads + +In contrast to Deployments, these API objects are finite. They stop once the specified number of Pods have completed successfully. + +* **{% glossary_tooltip text="Jobs" term_id="job" %}** - You can use these for one-off tasks like running a script or setting up a work queue. These tasks can be executed sequentially or in parallel. These tasks should be relatively independent, as Jobs do not support closely communicating parallel processes. [Read more about Job patterns](/docs/concepts/workloads/controllers/jobs-run-to-completion/#job-patterns){:target="_blank"}. + +* **{% glossary_tooltip text="CronJobs" term_id="cronjob" %}** - These are similar to Jobs, but allow you to schedule their execution for a specific time or for periodic recurrence. You might use CronJobs to send reminder emails or to run backup jobs. They are set up with a similar syntax as *crontab*. + +#### Other resources + +For more info, you can check out [a list of additional Kubernetes resource types](/docs/reference/kubectl/overview/#resource-types){:target="_blank"} as well as the [API reference docs]({{ reference_docs_url }}){:target="_blank"}. + +There may be additional features not mentioned here that you may find useful, which are covered in the [full Kubernetes documentation](/docs/home/?path=browse){:target="_blank"}. + +## Deploy a production-ready workload + +The beginner tutorials on this site, such as the [Guestbook app](/docs/tutorials/stateless-application/guestbook/){:target="_blank"}, are geared towards getting workloads up and running on your cluster. This prototyping is great for building your intuition around Kubernetes! However, in order to reliably and securely promote your workloads to production, you need to follow some additional best practices. + +#### Declarative configuration + +You are likely interacting with your Kubernetes cluster via {% glossary_tooltip text="kubectl" term_id="kubectl" %}. kubectl can be used to debug the current state of your cluster (such as checking the number of nodes), or to modify live Kubernetes objects (such as updating a workload's replica count with `kubectl scale`). + +When using kubectl to update your Kubernetes objects, it's important to be aware that different commands correspond to different approaches: +* [Purely imperative](/docs/tutorials/object-management-kubectl/imperative-object-management-command/){:target="_blank"} +* [Imperative with local configuration files](/docs/tutorials/object-management-kubectl/imperative-object-management-configuration/){:target="_blank"} (typically YAML) +* [Declarative with local configuration files](/docs/tutorials/object-management-kubectl/declarative-object-management-configuration/){:target="_blank"} (typically YAML) + +There are pros and cons to each approach, though the declarative approach (such as `kubectl apply -f`) may be most helpful in production. With this approach, you rely on local YAML files as the source of truth about your desired state. This enables you to version control your configuration, which is helpful for code reviews and audit tracking. + +For additional configuration best practices, familiarize yourself with [this guide](/docs/concepts/configuration/overview/){:target="_blank"}. + +#### Security + +You may be familiar with the *principle of least privilege*---if you are too generous with permissions when writing or using software, the negative effects of a compromise can escalate out of control. Would you be cautious handing out `sudo` privileges to software on your OS? If so, you should be just as careful when granting your workload permissions to the {% glossary_tooltip text="Kubernetes API" term_id="kubernetes-api" %} server! The API server is the gateway for your cluster's source of truth; it provides endpoints to read or modify cluster state. + +You (or your {% glossary_tooltip text="cluster operator" term_id="cluster-operator" %}) can lock down API access with the following: +* **{% glossary_tooltip text="ServiceAccounts" term_id="service-account" %}** - An "identity" that your Pods can be tied to +* **{% glossary_tooltip text="RBAC" term_id="rbac" %}** - One way of granting your ServiceAccount explicit permissions + +For even more comprehensive reading about security best practices, consider checking out the following topics: +* [Authentication](/docs/admin/authentication/){:target="_blank"} (Is the user who they say they are?) +* [Authorization](/docs/admin/authorization/){:target="_blank"} (Does the user actually have permissions to do what they're asking?) + +#### Resource isolation and management + +If your workloads are operating in a *multi-tenant* environment with multiple teams or projects, your container(s) are not necessarily running alone on their node(s). They are sharing node resources with other containers which you do not own. + +Even if your cluster operator is managing the cluster on your behalf, it is helpful to be aware of the following: +* **{% glossary_tooltip text="Namespaces" term_id="namespace" %}**, used for isolation +* **[Resource quotas](/docs/concepts/policy/resource-quotas/){:target="_blank"}**, which affect what your team's workloads can use +* **[Memory](/docs/tasks/configure-pod-container/assign-memory-resource/){:target="_blank"} and [CPU](/docs/tasks/configure-pod-container/assign-cpu-resource/){:target="_blank"} requests**, for a given Pod or container +* **[Monitoring](/docs/tasks/debug-application-cluster/resource-usage-monitoring/){:target="_blank"}**, both on the cluster level and the app level + +This list may not be completely comprehensive, but many teams have existing processes that take care of all this. If this is not the case, you'll find the Kubernetes documentation fairly rich in detail. + +## Improve your dev workflow with tooling + +As an app developer, you'll likely encounter the following tools in your workflow. + +#### kubectl + +`kubectl` is a command-line tool that allows you to easily read or modify your Kubernetes cluster. It provides convenient, short commands for common operations like scaling app instances and getting node info. How does kubectl do this? It's basically just a user-friendly wrapper for making API requests. It's written using [client-go](https://github.com/kubernetes/client-go/#client-go){:target="_blank"}, the Go library for the Kubernetes API. + +To learn about the most commonly used kubectl commands, check out the [kubectl cheatsheet](/docs/reference/kubectl/cheatsheet/){:target="_blank"}. It explains topics such as the following: +* [kubeconfig files](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/){:target="_blank"} - Your kubeconfig file tells kubectl what cluster to talk to, and can reference multiple clusters (such as dev and prod). +* [The various output formats available](/docs/reference/kubectl/cheatsheet/#formatting-output){:target="_blank"} - This is useful to know when you are using `kubectl get` to list information about certain API objects. + +* [The JSONPath output format](/docs/reference/kubectl/jsonpath/){:target="_blank"} - This is related to the output formats above. JSONPath is especially useful for parsing specific subfields out of `kubectl get` output (such as the URL of a {% glossary_tooltip text="Service" term_id="service" %}). + +* [`kubectl run` vs `kubectl apply`](/docs/reference/kubectl/conventions/){:target="_blank"} - This ties into the [declarative configuration](#declarative-configuration) discussion in the previous section. + +For the full list of kubectl commands and their options, check out [the reference guide](/docs/reference/generated/kubectl/kubectl-commands){:target="_blank"}. + +#### Helm + +To leverage pre-packaged configurations from the community, you can use **{% glossary_tooltip text="Helm charts" term_id="helm-chart" %}**. + +Helm charts package up YAML configurations for specific apps like Jenkins and Postgres. You can then install and run these apps on your cluster with minimal extra configuration. This approach makes the most sense for "off-the-shelf" components which do not require much custom implementation logic. + +For writing your own Kubernetes app configurations, there is a [thriving ecosystem of tools](https://docs.google.com/a/heptio.com/spreadsheets/d/1FCgqz1Ci7_VCz_wdh8vBitZ3giBtac_H8SBw4uxnrsE/edit?usp=drive_web){:target="_blank"} that you may find useful. + +## Explore additional resources + +#### References +Now that you're fairly familiar with Kubernetes, you may find it useful to browse the following reference pages. Doing so provides a high level view of what other features may exist: + +* [Commonly used `kubectl` commands](/docs/reference/kubectl/cheatsheet/){:target="_blank"} +* [Kubernetes API reference]({{ reference_docs_url }}){:target="_blank"} +* [Standardized Glossary](/docs/reference/glossary/){:target="_blank"} + +In addition, [the Kubernetes blog](http://blog.kubernetes.io/){:target="_blank"} often has helpful posts on Kubernetes design patterns and case studies. + +#### What's next +If you feel fairly comfortable with the topics on this page and want to learn more, check out the following user journeys: +* [Advanced App Developer](/docs/user-journeys/users/application-developer/advanced/){:target="_blank"} - Dive deeper, with the next level of this journey. +* [Foundational Cluster Operator](/docs/user-journeys/users/cluster-operator/foundational/){:target="_blank"} - Build breadth, by exploring other journeys. +{% endcapture %} + +{% include templates/user-journey-content.md %} diff --git a/docs/user-journeys/users/cluster-operator/_advanced.md b/docs/user-journeys/users/cluster-operator/_advanced.md new file mode 100644 index 0000000000000..9be8e999f6073 --- /dev/null +++ b/docs/user-journeys/users/cluster-operator/_advanced.md @@ -0,0 +1,84 @@ +--- +reviewers: +- chenopis +layout: docsportal +css: /css/style_user_journeys.css, https://fonts.googleapis.com/icon?family=Material+Icons +js: https://use.fontawesome.com/4bcc658a89.js, https://cdnjs.cloudflare.com/ajax/libs/prefixfree/1.0.7/prefixfree.min.js +title: Advanced Topics +track: "USERS > CLUSTER OPERATOR > ADVANCED" +--- + +{% capture overview %} + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +{% endcapture %} + + + +{% capture body %} +## Setup federated clusters + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +## Deploy an application with advanced features + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +## Explore advanced topics + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +## Additional resources + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean id felis non enim faucibus lacinia. Aliquam massa mauris, interdum a ex ut, sagittis rutrum nulla. In pellentesque est at molestie fringilla. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec eu mi at velit lacinia venenatis ac nec sem. In volutpat pellentesque dui ut commodo. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis sollicitudin eleifend felis non facilisis. Pellentesque leo urna, congue id auctor non, varius a nunc. Duis ultrices, odio ut hendrerit suscipit, nisi mauris dignissim mauris, nec bibendum ante neque ut augue. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam condimentum libero sit amet rutrum fermentum. Proin posuere condimentum odio. Aenean volutpat, ex vel tincidunt tincidunt, massa odio condimentum lectus, vel iaculis libero dolor in nisi. + +Curabitur bibendum tempor mi, vel lacinia nisi vulputate ac. Nulla dignissim consectetur nisl nec tincidunt. Etiam pharetra facilisis sapien, non gravida velit fermentum sed. Ut ac ultrices nunc, in vestibulum urna. Suspendisse accumsan euismod felis, sit amet rhoncus neque volutpat luctus. Aliquam tincidunt pellentesque mauris, sed tempus diam. Mauris in elit eget justo tempor suscipit. + +Aenean suscipit arcu ac leo tincidunt tempus. Donec maximus tellus libero, ac ullamcorper magna lobortis ac. Integer mollis nisl vitae magna gravida, nec ornare ex consectetur. Sed mattis tincidunt nisi, at consequat tellus malesuada non. Integer vel semper nisi, ut fringilla velit. Nam felis ex, congue non dui vitae, sollicitudin convallis turpis. Phasellus porttitor maximus turpis, in varius nibh fermentum aliquam. Cras finibus lacus non diam porttitor porttitor. Nulla fringilla sagittis nibh nec condimentum. Duis egestas mauris nec dolor hendrerit ullamcorper sit amet in mi. Phasellus sollicitudin justo diam. + +{% endcapture %} + +{% include templates/user-journey-content.md %} diff --git a/docs/user-journeys/users/cluster-operator/foundational.md b/docs/user-journeys/users/cluster-operator/foundational.md new file mode 100644 index 0000000000000..66148a7da5192 --- /dev/null +++ b/docs/user-journeys/users/cluster-operator/foundational.md @@ -0,0 +1,98 @@ +--- +reviewers: +- chenopis +layout: docsportal +css: /css/style_user_journeys.css, https://fonts.googleapis.com/icon?family=Material+Icons +js: https://use.fontawesome.com/4bcc658a89.js, https://cdnjs.cloudflare.com/ajax/libs/prefixfree/1.0.7/prefixfree.min.js +title: Foundational +track: "USERS › CLUSTER OPERATOR › FOUNDATIONAL" +--- + +{% capture overview %} + +If you want to learn how to get started managing and operating a Kubernetes cluster, this page and the linked topics introduce you to the foundational concepts and tasks. +This page introduces you to a Kubernetes cluster and key concepts to understand and manage it. The content focuses primarily on the cluster itself rather than the software running within the cluster. + +{% endcapture %} + + + +{% capture body %} + +## Get an overview of Kubernetes + +If you have not already done so, start your understanding by reading through [What is Kubernetes?](/docs/concepts/overview/what-is-kubernetes/), which introduces a number of basic concepts and terms. + +Kubernetes is quite flexible, and a cluster can be run in a wide variety of places. You can interact with Kubernetes entirely on your own laptop or local development machine with it running within a virtual machine. Kubernetes can also run on virtual machines hosted either locally or in a cloud provider, and you can run a Kubernetes cluster on bare metal. + +A cluster is made up of one or more [Nodes](/docs/concepts/architecture/nodes/); where a node is a physical or virtual machine. +If there is more than one node in your cluster then the nodes are connected with a [cluster network](/docs/concepts/cluster-administration/networking/). +Regardless of how many nodes, all Kubernetes clusters generally have the same components, which are described in [Kubernetes Components](/docs/concepts/overview/components). + + +## Learn about Kubernetes basics + +A good way to become familiar with how to manage and operate a Kubernetes cluster is by setting one up. +One of the most compact ways to experiment with a cluster is [Installing and using Minikube](/docs/tasks/tools/install-minikube/). +Minikube is a command line tool for setting up and running a single-node cluster within a virtual machine on your local laptop or development computer. Minikube is even available through your browser at the [Katacoda Kubernetes Playground](https://www.katacoda.com/courses/kubernetes/playground). +Katacoda provides a browser-based connection to a single-node cluster, using minikube behind the scenes, to support a number of tutorials to explore Kubernetes. You can also leverage the web-based [Play with Kubernetes](http://labs.play-with-k8s.com/) to the same ends - a temporary cluster to play with on the web. + +You interact with Kubernetes either through a dashboard, an API, or using a command-line tool (such as `kubectl`) that interacts with the Kubernetes API. +Be familiar with [Organizing Cluster Access](/docs/concepts/configuration/organize-cluster-access-kubeconfig/) by using configuration files. +The Kubernetes API exposes a number of resources that provide the building blocks and abstractions that are used to run software on Kubernetes. +Learn more about these resources at [Understanding Kubernetes Objects](/docs/concepts/overview/working-with-objects/kubernetes-objects). +These resources are covered in a number of articles within the Kubernetes documentation. + +* [Pod Overview](/docs/concepts/workloads/pods/pod-overview/) + * [Pods](/docs/concepts/workloads/pods/pod/) + * [ReplicaSets](/docs/concepts/workloads/controllers/replicaset/) + * [Deployments](/docs/concepts/workloads/controllers/deployment/) + * [Garbage Collection](/docs/concepts/workloads/controllers/garbage-collection/) + * [Container Images](/docs/concepts/containers/images/) + * [Container Environment Variables](/docs/concepts/containers/container-environment-variables/) +* [Labels and Selectors](/docs/concepts/overview/working-with-objects/labels/) +* [Namespaces](/docs/concepts/overview/working-with-objects/namespaces/) + * [Namespaces Walkthrough](/docs/tasks/administer-cluster/namespaces-walkthrough/) +* [Services](/docs/concepts/services-networking/service/) +* [Annotations](/docs/concepts/overview/working-with-objects/annotations/) +* [ConfigMaps](/docs/tasks/configure-pod-container/configure-pod-configmap/) +* [Secrets](/docs/concepts/configuration/secret/) + +As a cluster operator you may not need to use all these resources, although you should be familiar with them to understand how the cluster is being used. +There are a number of additional resources that you should be aware of, some listed under [Intermediate Resources](/docs/user-journeys/users/cluster-operator/intermediate#section-1). +You should also be familiar with [how to manage kubernetes resources](/docs/concepts/cluster-administration/manage-deployment/). + +## Get information about your cluster + +You can [access clusters using the Kubernetes API](/docs/tasks/administer-cluster/access-cluster-api/). +If you are not already familiar with how to do this, you can review the [introductory tutorial](/docs/tutorials/kubernetes-basics/explore-intro/). +Using `kubectl`, you can retrieve information about your Kubernetes cluster very quickly. +To get basic information about the nodes in your cluster run the command `kubectl get nodes`. +You can get more detailed information for the same nodes with the command `kubectl describe nodes`. +You can see the status of the core of kubernetes with the command `kubectl get componentstatuses`. + +Some additional resources for getting information about your cluster and how it is operating include: + +* [Tools for Monitoring Compute, Storage, and Network Resources](/docs/tasks/debug-application-cluster/resource-usage-monitoring/) +* [Core metrics pipeline](/docs/tasks/debug-application-cluster/core-metrics-pipeline/) + * [Metrics](/docs/concepts/cluster-administration/controller-metrics/) + +## Explore additional resources + +### Tutorials + +* [Kubernetes Basics](/docs/tutorials/kubernetes-basics/) +* [Kubernetes 101](/docs/user-guide/walkthrough/) - kubectl command line interface and Pods +* [Kubernetes 201](/docs/user-guide/walkthrough/k8s201/) - labels, deployments, services, and health checking +* [Configuring Redis with a ConfigMap](/docs/tutorials/configuration/configure-redis-using-configmap/) +* Stateless Applications + * [Deploying PHP Guestbook with Redis](/docs/tutorials/stateless-application/guestbook/) + * [Expose an External IP address to access an application](/docs/tutorials/stateless-application/expose-external-ip-address/) + +{% endcapture %} + +{% include templates/user-journey-content.md %} diff --git a/docs/user-journeys/users/cluster-operator/intermediate.md b/docs/user-journeys/users/cluster-operator/intermediate.md new file mode 100644 index 0000000000000..a4f063e1de959 --- /dev/null +++ b/docs/user-journeys/users/cluster-operator/intermediate.md @@ -0,0 +1,108 @@ +--- +reviewers: +- chenopis +layout: docsportal +css: /css/style_user_journeys.css, https://fonts.googleapis.com/icon?family=Material+Icons +js: https://use.fontawesome.com/4bcc658a89.js, https://cdnjs.cloudflare.com/ajax/libs/prefixfree/1.0.7/prefixfree.min.js +title: Intermediate +track: "USERS > CLUSTER OPERATOR > INTERMEDIATE" +--- + +{% capture overview %} + +If you are a cluster operator looking to expand your grasp of Kubernetes, this page and its linked topics extend the information provided on the [foundational cluster operator page](/docs/user-journeys/users/cluster-operator/foundational). From this page you can get information on key Kubernetes tasks needed to manage a complete production cluster. + +{% endcapture %} + +{% capture body %} + +## Work with ingress, networking, storage, and workloads + +Introductions to Kubernetes typically discuss simple stateless applications. As you move into more complex development, testing, and production environments, you need to consider more complex cases: + +Communication: Ingress and Networking + +* [Ingress](/docs/concepts/services-networking/ingress/) + +Storage: Volumes and PersistentVolumes + +* [Volumes](/docs/concepts/storage/volumes/) +* [Persistent Volumes](/docs/concepts/storage/persistent-volumes/) + +Workloads + +* [DaemonSets](/docs/concepts/workloads/controllers/daemonset/) +* [Stateful Sets](/docs/concepts/workloads/controllers/statefulset/) +* [Jobs](/docs/concepts/workloads/controllers/jobs-run-to-completion/) +* [CronJobs](/docs/concepts/workloads/controllers/cron-jobs/) + +Pods + +* [Pod Lifecycle](/docs/concepts/workloads/pods/pod-lifecycle/) + * [Init Containers](/docs/concepts/workloads/pods/init-containers/) + * [Pod Presets](/docs/concepts/workloads/pods/podpreset/) + * [Container Lifecycle Hooks](/docs/concepts/containers/container-lifecycle-hooks/) + +And how Pods work with scheduling, priority, disruptions: + +* [Taints and Tolerations](/docs/concepts/configuration/taint-and-toleration/) +* [Pods and Priority](/docs/concepts/configuration/pod-priority-preemption/) +* [Disruptions](/docs/concepts/workloads/pods/disruptions/) +* [Assigning Pods to Nodes](/docs/concepts/configuration/assign-pod-node/) +* [Managing Compute Resources for Containers](/docs/concepts/configuration/manage-compute-resources-container/) +* [Configuration Best Practices](/docs/concepts/configuration/overview/) + +## Implement security best practices + +Securing your cluster includes work beyond the scope of Kubernetes itself. + +In Kubernetes, you configure access control: + +* [Controlling Access to the Kubernetes API](/docs/admin/accessing-the-api/) +* [Authenticating](/docs/admin/authentication/) +* [Using Admission Controllers](/docs/admin/admission-controllers/) + +You also configure authorization. That is, you determine not just how users and services authenticate to the API server, or whether they have access, but also what resources they have access to. Role-based access control (RBAC) is the recommended mechanism for controlling authorization to Kubernetes resources. Other authorization modes are available for more specific use cases. + +* [Authorization Overview](/docs/admin/authorization/) +* [Using RBAC Authorization](/docs/admin/authorization/rbac/) + +You should create Secrets to hold sensitive data such as passwords, tokens, or keys. Be aware, however, that there are limitations to the protections that a Secret can provide. See [the Risks section of the Secrets documentation](/docs/concepts/configuration/secret/#risks). + + + +## Implement custom logging and monitoring + +Monitoring the health and state of your cluster is important. Collecting metrics, logging, and providing access to that information are common needs. Kubernetes provides some basic logging structure, and you may want to use additional tools to help aggregate and analyze log data. + +Start with the [basics on Kubernetes logging](/docs/concepts/cluster-administration/logging/) to understand how containers do logging and common patterns. Cluster operators often want to add something to gather and aggregate those logs. See the following topics: + +* [Logging Using Elasticsearch and Kibana](/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana/) +* [Logging Using Stackdriver](/docs/tasks/debug-application-cluster/logging-stackdriver/) + +Like log aggregation, many clusters utilize additional software to help capture metrics and display them. There is an overview of tools at [Tools for Monitoring Compute, Storage, and Network Resources](/docs/tasks/debug-application-cluster/resource-usage-monitoring/). +Kubernetes also supports a [core metrics pipeline](/docs/tasks/debug-application-cluster/core-metrics-pipeline/) which can be used by Horizontal Pod Autoscaler with custom metrics. + +[Prometheus](https://prometheus.io/), which is another CNCF project, is a common choice to support capture and temporary collection of metrics. There are several options for installing Prometheus, including using the [stable/prometheus](https://github.com/kubernetes/charts/tree/master/stable/prometheus) [helm](https://helm.sh/) chart, and CoreOS provides a [prometheus operator](https://github.com/coreos/prometheus-operator) and [kube-prometheus](https://github.com/coreos/prometheus-operator/tree/master/contrib/kube-prometheus), which adds on Grafana dashboards and common configurations. + +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/). + +Hosted data analytics services such as [Datadog](https://docs.datadoghq.com/integrations/kubernetes/) also offer Kubernetes integration. + +## Additional resources + +Cluster Administration: + +* [Troubleshoot Clusters](/docs/tasks/debug-application-cluster/debug-cluster/) +* [Debug Pods and Replication Controllers](/docs/tasks/debug-application-cluster/debug-pod-replication-controller/) +* [Debug Init Containers](/docs/tasks/debug-application-cluster/debug-init-containers/) +* [Debug Stateful Sets](/docs/tasks/debug-application-cluster/debug-stateful-set/) +* [Debug Applications](/docs/tasks/debug-application-cluster/debug-application/) +* [Using explorer to investigate your cluster](https://github.com/kubernetes/examples/blob/master/staging/explorer/README.md) + +{% endcapture %} + +{% include templates/user-journey-content.md %} diff --git a/editdocs.md b/editdocs.md index 4c7b257ba1667..73d62db8abbe5 100644 --- a/editdocs.md +++ b/editdocs.md @@ -58,3 +58,8 @@ For more information about contributing to the Kubernetes documentation, see: * [Staging Your Documentation Changes](/docs/home/contribute/stage-documentation-changes/) * [Using Page Templates](/docs/home/contribute/page-templates/) * [Documentation Style Guide](/docs/home/contribute/style-guide/) +* How to work with generated documentation + * [Generating Reference Documentation for Kubernetes Federation API](/docs/home/contribute/generated-reference/federation-api/) + * [Generating Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/) + * [Generating Reference Documentation for the Kubernetes API](/docs/home/contribute/generated-reference/kubernetes-api/) + * [Generating Reference Pages for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/) diff --git a/images/CaseStudy_amadeus_banner1.jpg b/images/CaseStudy_amadeus_banner1.jpg new file mode 100644 index 0000000000000..5b330843f4ff3 Binary files /dev/null and b/images/CaseStudy_amadeus_banner1.jpg differ diff --git a/images/CaseStudy_amadeus_banner3.jpg b/images/CaseStudy_amadeus_banner3.jpg new file mode 100644 index 0000000000000..3c333a8e5abfe Binary files /dev/null and b/images/CaseStudy_amadeus_banner3.jpg differ diff --git a/images/CaseStudy_amadeus_banner4.jpg b/images/CaseStudy_amadeus_banner4.jpg new file mode 100644 index 0000000000000..89faa91de65f0 Binary files /dev/null and b/images/CaseStudy_amadeus_banner4.jpg differ diff --git a/images/CaseStudy_amadeus_banner_mobile.jpg b/images/CaseStudy_amadeus_banner_mobile.jpg new file mode 100644 index 0000000000000..466ec64af0df1 Binary files /dev/null and b/images/CaseStudy_amadeus_banner_mobile.jpg differ diff --git a/images/CaseStudy_haufegroup_banner1.jpg b/images/CaseStudy_haufegroup_banner1.jpg new file mode 100644 index 0000000000000..5e12bb41148c6 Binary files /dev/null and b/images/CaseStudy_haufegroup_banner1.jpg differ diff --git a/images/CaseStudy_haufegroup_banner3.jpg b/images/CaseStudy_haufegroup_banner3.jpg new file mode 100644 index 0000000000000..715a2b7e8fc6f Binary files /dev/null and b/images/CaseStudy_haufegroup_banner3.jpg differ diff --git a/images/CaseStudy_haufegroup_banner4.jpg b/images/CaseStudy_haufegroup_banner4.jpg new file mode 100644 index 0000000000000..14b2ed6aeb98f Binary files /dev/null and b/images/CaseStudy_haufegroup_banner4.jpg differ diff --git a/images/CaseStudy_huawei_banner1.jpg b/images/CaseStudy_huawei_banner1.jpg new file mode 100644 index 0000000000000..8d571e09be3be Binary files /dev/null and b/images/CaseStudy_huawei_banner1.jpg differ diff --git a/images/CaseStudy_huawei_banner3.jpg b/images/CaseStudy_huawei_banner3.jpg new file mode 100644 index 0000000000000..dfaa1f1d2fa73 Binary files /dev/null and b/images/CaseStudy_huawei_banner3.jpg differ diff --git a/images/CaseStudy_huawei_banner4.jpg b/images/CaseStudy_huawei_banner4.jpg new file mode 100644 index 0000000000000..f5a6f0b78e0dd Binary files /dev/null and b/images/CaseStudy_huawei_banner4.jpg differ diff --git a/images/amadeus.png b/images/amadeus.png new file mode 100644 index 0000000000000..6191c7f6819f2 Binary files /dev/null and b/images/amadeus.png differ diff --git a/images/amadeus_logo.png b/images/amadeus_logo.png new file mode 100644 index 0000000000000..700f631f8460d Binary files /dev/null and b/images/amadeus_logo.png differ diff --git a/images/case_studies/amadeus_feature.png b/images/case_studies/amadeus_feature.png new file mode 100644 index 0000000000000..d23d7b0163854 Binary files /dev/null and b/images/case_studies/amadeus_feature.png differ diff --git a/images/case_studies/haufegroup_logo.png b/images/case_studies/haufegroup_logo.png new file mode 100644 index 0000000000000..5d8245b0f6d18 Binary files /dev/null and b/images/case_studies/haufegroup_logo.png differ diff --git a/images/case_studies/haufegroup_logo_feature.png b/images/case_studies/haufegroup_logo_feature.png new file mode 100644 index 0000000000000..08b09ec9db8b7 Binary files /dev/null and b/images/case_studies/haufegroup_logo_feature.png differ diff --git a/images/case_studies/huawei.png b/images/case_studies/huawei.png new file mode 100644 index 0000000000000..94361a27eb5af Binary files /dev/null and b/images/case_studies/huawei.png differ diff --git a/images/case_studies/huawei_feature.png b/images/case_studies/huawei_feature.png new file mode 100644 index 0000000000000..22071b4691e38 Binary files /dev/null and b/images/case_studies/huawei_feature.png differ diff --git a/images/diamanti.png b/images/diamanti.png new file mode 100644 index 0000000000000..d4661c5ee539d Binary files /dev/null and b/images/diamanti.png differ diff --git a/images/haufegroup_logo.png b/images/haufegroup_logo.png new file mode 100644 index 0000000000000..6cbcd32d70951 Binary files /dev/null and b/images/haufegroup_logo.png differ diff --git a/images/huawei_logo.png b/images/huawei_logo.png new file mode 100644 index 0000000000000..78fc0fa6a1d04 Binary files /dev/null and b/images/huawei_logo.png differ diff --git a/images/journeys/placeholder.png b/images/journeys/placeholder.png new file mode 100644 index 0000000000000..bc45d90becdb4 Binary files /dev/null and b/images/journeys/placeholder.png differ diff --git a/images/square-logos/asag.png b/images/square-logos/asag.png new file mode 100644 index 0000000000000..a0eb75e61c10e Binary files /dev/null and b/images/square-logos/asag.png differ diff --git a/images/square-logos/baidu.png b/images/square-logos/baidu.png new file mode 100644 index 0000000000000..7a95a47ed5f3e Binary files /dev/null and b/images/square-logos/baidu.png differ diff --git a/images/square-logos/bloombase.png b/images/square-logos/bloombase.png new file mode 100644 index 0000000000000..00189e99dffa9 Binary files /dev/null and b/images/square-logos/bloombase.png differ diff --git a/images/square-logos/bluefyre.png b/images/square-logos/bluefyre.png new file mode 100644 index 0000000000000..6d207c0b0a882 Binary files /dev/null and b/images/square-logos/bluefyre.png differ diff --git a/images/square-logos/bocloud.png b/images/square-logos/bocloud.png new file mode 100644 index 0000000000000..6751ab904760c Binary files /dev/null and b/images/square-logos/bocloud.png differ diff --git a/images/square-logos/cascadeo.png b/images/square-logos/cascadeo.png new file mode 100644 index 0000000000000..cc6311199ea3f Binary files /dev/null and b/images/square-logos/cascadeo.png differ diff --git a/images/square-logos/circulo.png b/images/square-logos/circulo.png new file mode 100644 index 0000000000000..9108e0a1442a2 Binary files /dev/null and b/images/square-logos/circulo.png differ diff --git a/images/square-logos/codefresh.png b/images/square-logos/codefresh.png index 1ea7e6492b2b0..844a3b23063f8 100644 Binary files a/images/square-logos/codefresh.png and b/images/square-logos/codefresh.png differ diff --git a/images/square-logos/componentsoft.png b/images/square-logos/componentsoft.png index df326a3ff3a57..a86ede2b7453b 100644 Binary files a/images/square-logos/componentsoft.png and b/images/square-logos/componentsoft.png differ diff --git a/images/square-logos/devopsguru.png b/images/square-logos/devopsguru.png new file mode 100644 index 0000000000000..5d9f621d9b63f Binary files /dev/null and b/images/square-logos/devopsguru.png differ diff --git a/images/square-logos/ein.png b/images/square-logos/ein.png new file mode 100644 index 0000000000000..144b749d1fc41 Binary files /dev/null and b/images/square-logos/ein.png differ diff --git a/images/square-logos/eking.png b/images/square-logos/eking.png new file mode 100644 index 0000000000000..58db57e78a450 Binary files /dev/null and b/images/square-logos/eking.png differ diff --git a/images/square-logos/elastisys.png b/images/square-logos/elastisys.png index b05eb8a1aed8a..d74b18368cdb4 100644 Binary files a/images/square-logos/elastisys.png and b/images/square-logos/elastisys.png differ diff --git a/images/square-logos/google.png b/images/square-logos/google.png index 685c32cc2c2c2..99eed95928aa7 100644 Binary files a/images/square-logos/google.png and b/images/square-logos/google.png differ diff --git a/images/square-logos/greenfield.png b/images/square-logos/greenfield.png new file mode 100644 index 0000000000000..90b2669c398cb Binary files /dev/null and b/images/square-logos/greenfield.png differ diff --git a/images/square-logos/guardicore.png b/images/square-logos/guardicore.png new file mode 100644 index 0000000000000..b0b82839db14e Binary files /dev/null and b/images/square-logos/guardicore.png differ diff --git a/images/square-logos/harmony.png b/images/square-logos/harmony.png new file mode 100644 index 0000000000000..a6b5dd19d6d22 Binary files /dev/null and b/images/square-logos/harmony.png differ diff --git a/images/square-logos/harness.png b/images/square-logos/harness.png new file mode 100644 index 0000000000000..6063369d817d3 Binary files /dev/null and b/images/square-logos/harness.png differ diff --git a/images/square-logos/hedvig.png b/images/square-logos/hedvig.png new file mode 100644 index 0000000000000..6ef09d7c7aa8b Binary files /dev/null and b/images/square-logos/hedvig.png differ diff --git a/images/square-logos/hpe.png b/images/square-logos/hpe.png new file mode 100644 index 0000000000000..5d2965a6da3ea Binary files /dev/null and b/images/square-logos/hpe.png differ diff --git a/images/square-logos/humio.png b/images/square-logos/humio.png new file mode 100644 index 0000000000000..8e35a8eae2537 Binary files /dev/null and b/images/square-logos/humio.png differ diff --git a/images/square-logos/jetbrains.png b/images/square-logos/jetbrains.png new file mode 100644 index 0000000000000..f9303abccdac9 Binary files /dev/null and b/images/square-logos/jetbrains.png differ diff --git a/images/square-logos/kasten.png b/images/square-logos/kasten.png new file mode 100644 index 0000000000000..bd4eede5d2055 Binary files /dev/null and b/images/square-logos/kasten.png differ diff --git a/images/square-logos/kinvolk.png b/images/square-logos/kinvolk.png index 25ff91bc757c9..eefda49ddad4d 100644 Binary files a/images/square-logos/kinvolk.png and b/images/square-logos/kinvolk.png differ diff --git a/images/square-logos/kloia.png b/images/square-logos/kloia.png new file mode 100644 index 0000000000000..f65b69b09d43c Binary files /dev/null and b/images/square-logos/kloia.png differ diff --git a/images/square-logos/kong.png b/images/square-logos/kong.png new file mode 100644 index 0000000000000..0cd5e29c70d70 Binary files /dev/null and b/images/square-logos/kong.png differ diff --git a/images/square-logos/landoop.png b/images/square-logos/landoop.png new file mode 100644 index 0000000000000..67aa8617273c4 Binary files /dev/null and b/images/square-logos/landoop.png differ diff --git a/images/square-logos/mobilise.png b/images/square-logos/mobilise.png new file mode 100644 index 0000000000000..0a20f4b3bbcad Binary files /dev/null and b/images/square-logos/mobilise.png differ diff --git a/images/square-logos/naitways.png b/images/square-logos/naitways.png new file mode 100644 index 0000000000000..318b9c047f51a Binary files /dev/null and b/images/square-logos/naitways.png differ diff --git a/images/square-logos/opensense.png b/images/square-logos/opensense.png new file mode 100644 index 0000000000000..f7d0439c37f73 Binary files /dev/null and b/images/square-logos/opensense.png differ diff --git a/images/square-logos/outcold.png b/images/square-logos/outcold.png new file mode 100644 index 0000000000000..c759f89f24754 Binary files /dev/null and b/images/square-logos/outcold.png differ diff --git a/images/square-logos/platform9.png b/images/square-logos/platform9.png index bb1893d14dae4..c44a3cd7e3ed1 100644 Binary files a/images/square-logos/platform9.png and b/images/square-logos/platform9.png differ diff --git a/images/square-logos/polarseven.png b/images/square-logos/polarseven.png new file mode 100644 index 0000000000000..21025273fb6be Binary files /dev/null and b/images/square-logos/polarseven.png differ diff --git a/images/square-logos/redis.png b/images/square-logos/redis.png new file mode 100644 index 0000000000000..98ffeef39cb05 Binary files /dev/null and b/images/square-logos/redis.png differ diff --git a/images/square-logos/rxm.png b/images/square-logos/rxm.png index 6de6152f3a03a..be800f741d039 100644 Binary files a/images/square-logos/rxm.png and b/images/square-logos/rxm.png differ diff --git a/images/square-logos/spotinst.png b/images/square-logos/spotinst.png index 2faf7113506ac..14ea926d0b1c1 100644 Binary files a/images/square-logos/spotinst.png and b/images/square-logos/spotinst.png differ diff --git a/images/square-logos/superorbital.png b/images/square-logos/superorbital.png new file mode 100644 index 0000000000000..f28bae65c8e81 Binary files /dev/null and b/images/square-logos/superorbital.png differ diff --git a/images/square-logos/syseleven.png b/images/square-logos/syseleven.png new file mode 100644 index 0000000000000..f23fd969d13ab Binary files /dev/null and b/images/square-logos/syseleven.png differ diff --git a/images/square-logos/wavefront.png b/images/square-logos/wavefront.png new file mode 100644 index 0000000000000..31d482a1cee15 Binary files /dev/null and b/images/square-logos/wavefront.png differ diff --git a/images/square-logos/woqutech.png b/images/square-logos/woqutech.png new file mode 100644 index 0000000000000..d96fa45f0d0df Binary files /dev/null and b/images/square-logos/woqutech.png differ diff --git a/images/square-logos/zte.png b/images/square-logos/zte.png new file mode 100644 index 0000000000000..b99b826b85e15 Binary files /dev/null and b/images/square-logos/zte.png differ diff --git a/js/user-journeys/home.js b/js/user-journeys/home.js new file mode 100644 index 0000000000000..9c3c7d1a7268a --- /dev/null +++ b/js/user-journeys/home.js @@ -0,0 +1,324 @@ +$( document ).ready(function() { + // UI defaults, used if page is loaded without other params + var defaults = { + path: 'users', + persona: 'app-developer', + level: 'foundational' + }; + // Top-level path types + var pathTypes = [ + 'users', + 'contributors', + 'migrators', + 'browse', + 'about' + ]; + // Paths that do not adhere to the actual user journey UI + var specialJourneyPaths = [ + 'browse', + 'about', + ]; + // Load persona JSON data structure + var info = JSON.parse($('#user-persona-data').html()); + + var containerDivs = [ + '.applicationDeveloperContainer', + '.infobarWrapper', + '#cardWrapper', + '#browsedocsWrapper', + '#aboutWrapper' + ]; + + // Stateful wrapper for a regular hash. Stores parameters AND keeps them in + // sync with the URL state. + var urlParamHash = function() { + var paramHash = {}; + + // Initialize internal params based on URL state + function init() { + var sPageURL = decodeURIComponent(window.location.search.substring(1)), + sURLVariables = sPageURL.split('&'), + sParameterName, + i; + + paramHash = {}; + for (i = 0; i < sURLVariables.length; i++) { + sParameterName = sURLVariables[i].split('='); + if (sParameterName[0] != "" && sParameterName[1] != "") + paramHash[sParameterName[0]] = sParameterName[1]; + } + return paramHash; // for visibility + } + + // Update both internal params and URL state + function set(key, value) { + if (value == null) { + delete paramHash[key]; + } else { + paramHash[key] = value; + } + + var urlWithoutQuery = window.location.href.split('?')[0]; + var urlHash = window.location.hash; + window.history.pushState(null,null, urlWithoutQuery + "?" + $.param(paramHash) + window.location.hash); + return paramHash; // for visibility + } + + // Get value from hash based on key + function get(key) { + return paramHash[key]; + } + + // Return number of elements in hash + function numElts() { + return Object.keys(paramHash).length; + } + + return { + init: init, + set: set, + get: get, + numElts: numElts, + }; + }(); + + // Create persona buttons in "I am..." section, e.g. Application Developer + function buildCards() { + for (var c in info) { + var card = document.createElement('div'); + card.className += "card_" + c; + + for (var i in info[c]) { + var button = document.createElement('div'); + button.className += 'buttons'; + button.setAttribute('data-button', i); + button.innerText = info[c][i]["name"]; + card.appendChild(button); + } + $('.cards').append(card); + } + } + + // Generate HTML for info links + function getInfoLinkHtml( + i = 1 //enumeration index for link id + , linkLabel = "Missing link label." //info link text + , linkUrl = "/docs/home/" //link to content + , linkIcon = "fa-ellipsis-h" //icon preceding info link text + ) { + var html = ''; + + /* + html template: +
+
+ +
+
Missing link label.
+
+ + defaults: + label: "Missing link label." + icon: "fa-ellipsis-h" + url: "docs.html" + */ + + html = '
' + + '
' + + '' + + '
' + + '
'+linkLabel+'
' + + '
'; + + return html; + } + + // Set links in the "I want to..." section, e.g. Setup a development environment + function setInfoData() { + var path = urlParamHash.get("path"); + var persona = urlParamHash.get("persona"); + var level = urlParamHash.get("level"); + + // info links specific to type/button/level + var contentArray = (typeof info[path][persona] !== 'undefined') + ? info[path][persona][level] + : [{ + label: 'Please select a role or persona in the "I AM..." section above.', + url: '#cardWrapper', + icon: 'fa-exclamation' + }]; + + //clear contents of #infobarLinks div + $('#infobarLinks').empty(); + //process and add each info link + for(i = 1; i <= contentArray.length; i++) { + var content = contentArray[i-1]; + + //append link to the end of the div + $('#infobarLinks').append(getInfoLinkHtml(i,content.label,content.url,content.icon)); + } + $('.infobarWrapper').css('visibility', 'visible'); + } + + // Hide persona wizard section if Browse Docs button is clicked + function toggleSections(path){ + for (i in containerDivs) { + if (!isSpecialJourney(path)) { + $(containerDivs[i]).show(); + } else { + $(containerDivs[i]).hide(); + } + } + + if (!isSpecialJourney(path)) { + $('.card_' + path).show(); + // TBD: Add code to set button to default to first in path list? + } else if (path == "browse") { + $('#browsedocsWrapper').show(); + } else if (path == "about") { + $('#aboutWrapper').show(); + } + } + + function isSpecialJourney(path) { + return (specialJourneyPaths.indexOf(path) != -1); + } + + // Click handler for high-level user journey paths ("Users", "Contributors", etc) + function handlePathClick(targetElt, fromPageload) { + // (1) Update stored state if necessary + var type = urlParamHash.get("path"); + if (!fromPageload) { + for (var i in pathTypes) { + var pathType = pathTypes[i]; + if (RegExp(pathType).test(targetElt.className)) { + type = pathType; + } + } + urlParamHash.set("path", type); + urlParamHash.set("persona", null); + urlParamHash.set("level", null); + + // record Google Analytics event + ga('send', 'event', 'user-journeys', 'click', 'path', type); + + } + + // (2) HTML behavior + $('.navButton').removeClass("keepShow"); + $(targetElt).addClass("keepShow"); + $('.cards > div').hide(); + // Hide or show user journeys if "Browse Docs is selected" + toggleSections(type); + } + + // Click handler + scroll for persona buttons in "I am..." section + // NOTE: ALL persona clicks also set a level. + function handlePersonaClick(targetElt, fromPageload, noScroll) { + // (1) Update stored state if necessary + if (!fromPageload) { + var persona = targetElt.getAttribute('data-button'); + urlParamHash.set('persona', persona); + + // record Google Analytics event + ga('send', 'event', 'user-journeys', 'click', 'persona', persona); + + } + // Use default level if not specified, in order to display the proper + // path-persona-level content + if (urlParamHash.get('level') == null) { + urlParamHash.set('level', defaults.level); + } + + // (2) HTML behavior + $('.buttons').removeClass('selected'); + $(targetElt).addClass('selected'); + // Update header to display new persona and level + var cardText = targetElt.innerText; + $('#subTitle').text(cardText); + handleLevelClick($('.level[data-name="' + urlParamHash.get('level') + '"]')[0], fromPageload); + // Scroll to user journey content + if (!noScroll) { + $('html,body').animate({ scrollTop: $("#subTitle").offset().top },'slow'); + } + } + + function handleLevelClick(targetElt, fromPageload) { + // (1) Update stored state if necessary + var level = targetElt.getAttribute('data-name'); + if (!fromPageload) { + urlParamHash.set('level', level); + + // record Google Analytics event + ga('send', 'event', 'user-journeys', 'click', 'level', level); + + } + + // (2) HTML behavior + $('.level').removeClass('selected'); + $(targetElt).addClass('selected'); + // Data loading to display the right content + setInfoData(); + } + + function showPersonaDefinition(targetElt) { + var persona = targetElt.getAttribute('data-button'); + + console.log($('.persona-def-data[data-name="' + persona + '"]')[0].innerHTML); + $("#persona-definition").html($('.persona-def-data[data-name="' + persona + '"]')[0].innerHTML); + $("#persona-definition").css("visibility", "visible"); + } + + function attachCardEvents() { + // Set up click handling for all paths ("Users", "Contributors", etc) + $('.paths .navButton').on('click', function(e) { + handlePathClick(e.currentTarget); + }); + // Set up click handling for personas ("Application Developer", etc) + $('.cards .buttons').on('click', function(e) { + handlePersonaClick(e.currentTarget); + }); + // Show persona definitions when hovering over card + $('.cards .buttons').hover( function(e) { + showPersonaDefinition(e.currentTarget); + }, function(e) { + $("#persona-definition").css("visibility", "hidden"); + $("#persona-definition").html("."); + }); + // Set up click handling for levels ("Foundational", "Intermediate", etc) + $('.level').on('click', function(e) { + handleLevelClick(e.currentTarget); + }); + } + + // Set up state based on URL query parameters or defaults + function setupCardState() { + // Initialize stored state + urlParamHash.init(); + var noScroll = urlParamHash.numElts() == 0; + for (key in defaults) { + if (!isSpecialJourney(urlParamHash.get('path')) && urlParamHash.get(key) == undefined) { + urlParamHash.set(key, defaults[key]); + } + } + // Update UI + handlePathClick($('.paths .' + urlParamHash.get('path'))[0], true); + if (!isSpecialJourney(urlParamHash.get('path'))) { + setTimeout(function() { + var elt = $('div[data-button="' + urlParamHash.get('persona') + '"]')[0]; + handlePersonaClick(elt, true, noScroll); + }, 200); + } + } + + function main() { + // Set up UI + buildCards(); + attachCardEvents(); + // Set up and display user journey state + setupCardState(); + } + + // What actually executes on page load + main(); +}); diff --git a/js/user-journeys/toc.js b/js/user-journeys/toc.js new file mode 100644 index 0000000000000..dc527bc55044f --- /dev/null +++ b/js/user-journeys/toc.js @@ -0,0 +1,30 @@ +$( document ).ready(function() { + function scrollToHash(hash) { + if (hash.length > 0) { + $('html, body').animate({ + scrollTop: $(`#${hash}`).offset().top + }, 500); + } + } + + $('#content h2').each(function(index) { + var title = $(this).text(); + var id = $(this).attr("id"); + + // inject headers into user journeys table-of-contents (buttons) + $("#user-journeys-toc").append(`
${index + 1}. ${title}
`) + + // replace content headers with styled banners + $(this).replaceWith(`


${index + 1}  ${title}
`) + }); + + $('div#user-journeys-toc a').each(function() { + $(this).click(function() { + var target = $(this).attr("href").replace("#", ""); + scrollToHash(target); + }); + }); + + // jump to section in URL now that anchors are created + scrollToHash(window.location.hash.substr(1)); +}); diff --git a/skip_toc_check.txt b/skip_toc_check.txt index dab2f8437930b..b8cd18d719c44 100644 --- a/skip_toc_check.txt +++ b/skip_toc_check.txt @@ -67,3 +67,4 @@ docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md +docs/user-journeys/users/cluster-operator/_advanced.md diff --git a/test/examples_test.go b/test/examples_test.go index 2b237749f387a..50279a210a6a1 100644 --- a/test/examples_test.go +++ b/test/examples_test.go @@ -56,7 +56,7 @@ import ( storage_validation "k8s.io/kubernetes/pkg/apis/storage/validation" "k8s.io/kubernetes/pkg/capabilities" "k8s.io/kubernetes/pkg/registry/batch/job" - schedulerapilatest "k8s.io/kubernetes/pkg/scheduler/api/latest" + schedulerapilatest "k8s.io/kubernetes/plugin/pkg/scheduler/api/latest" ) func validateObject(obj runtime.Object) (errors field.ErrorList) { @@ -298,10 +298,15 @@ func TestExampleObjectSchemas(t *testing.T) { "counter-pod": {&api.Pod{}}, "fluentd-sidecar-config": {&api.ConfigMap{}}, "nginx-app": {&api.Service{}, &extensions.Deployment{}}, + "nginx-deployment": {&extensions.Deployment{}}, "two-files-counter-pod": {&api.Pod{}}, "two-files-counter-pod-agent-sidecar": {&api.Pod{}}, "two-files-counter-pod-streaming-sidecar": {&api.Pod{}}, }, + "../docs/concepts/cluster-administration/nginx": { + "nginx-deployment": {&extensions.Deployment{}}, + "nginx-svc": {&api.Service{}}, + }, "../docs/concepts/configuration": { "commands": {&api.Pod{}}, "pod": {&api.Pod{}}, @@ -473,6 +478,9 @@ func TestExampleObjectSchemas(t *testing.T) { "hello-apparmor-pod": {&api.Pod{}}, "my-scheduler": {&extensions.Deployment{}}, }, + "../docs/tutorials/configuration/configmap/redis": { + "redis-pod": {&api.Pod{}}, + }, "../docs/concepts/overview/object-management-kubectl": { "simple_deployment": {&extensions.Deployment{}}, "update_deployment": {&extensions.Deployment{}}, @@ -513,7 +521,6 @@ func TestExampleObjectSchemas(t *testing.T) { "multi-pod": {&api.Pod{}, &api.Pod{}}, "new-nginx-deployment": {&extensions.Deployment{}}, "nginx-app": {&api.Service{}, &extensions.Deployment{}}, - "nginx-deployment": {&extensions.Deployment{}}, "nginx-init-containers": {&api.Pod{}}, "nginx-lifecycle-deployment": {&extensions.Deployment{}}, "nginx-probe-deployment": {&extensions.Deployment{}}, @@ -533,43 +540,11 @@ func TestExampleObjectSchemas(t *testing.T) { "mount-file-pod": {&api.Pod{}}, "volume-pod": {&api.Pod{}}, }, - "../docs/user-guide/configmap/redis": { - "redis-pod": {&api.Pod{}}, - }, - "../docs/user-guide/downward-api": { - "dapi-pod": {&api.Pod{}}, - "dapi-container-resources": {&api.Pod{}}, - }, - "../docs/user-guide/downward-api/volume": { - "dapi-volume": {&api.Pod{}}, - "dapi-volume-resources": {&api.Pod{}}, - }, - "../docs/user-guide/environment-guide": { - "backend-rc": {&api.ReplicationController{}}, - "backend-srv": {&api.Service{}}, - "show-rc": {&api.ReplicationController{}}, - "show-srv": {&api.Service{}}, - }, - "../docs/user-guide/horizontal-pod-autoscaling": { - "hpa-php-apache": {&autoscaling.HorizontalPodAutoscaler{}}, - }, - "../docs/user-guide/jobs/work-queue-1": { - "job": {&batch.Job{}}, - }, - "../docs/user-guide/jobs/work-queue-2": { - "job": {&batch.Job{}}, - "redis-pod": {&api.Pod{}}, - "redis-service": {&api.Service{}}, - }, "../docs/user-guide/liveness": { "exec-liveness": {&api.Pod{}}, "http-liveness": {&api.Pod{}}, "http-liveness-named-port": {&api.Pod{}}, }, - "../docs/user-guide/nginx": { - "nginx-deployment": {&extensions.Deployment{}}, - "nginx-svc": {&api.Service{}}, - }, "../docs/user-guide/node-selection": { "pod": {&api.Pod{}}, "pod-with-node-affinity": {&api.Pod{}}, @@ -689,7 +664,7 @@ func TestExampleObjectSchemas(t *testing.T) { // 6) Look for #5 followed by a newline followed by ``` (end of the code block) // // This could probably be simplified, but is already too delicate. Before any -// real changes, we should have a testscase that just tests this regex. +// real changes, we should have a test case that just tests this regex. var sampleRegexp = regexp.MustCompile("(?ms)^```(?:(?Pyaml)\\w*\\n(?P.+?)|\\w*\\n(?P\\{.+?\\}))\\n^```") var subsetRegexp = regexp.MustCompile("(?ms)\\.{3}") diff --git a/update-imported-docs/community.yml b/update-imported-docs/community.yml index 6a57c71630ea6..b812d53007142 100644 --- a/update-imported-docs/community.yml +++ b/update-imported-docs/community.yml @@ -10,5 +10,5 @@ repos: dst: docs/imported/community/guide.md - src: mentoring/README.md dst: docs/imported/community/mentoring.md - - src: keps/1-kubernetes-enhancement-proposal-process.md + - src: keps/0001-kubernetes-enhancement-proposal-process.md dst: docs/imported/community/keps.md diff --git a/update-imported-docs/update-imported-docs-linux b/update-imported-docs/update-imported-docs-linux new file mode 100755 index 0000000000000..a8a230c2b8c5c Binary files /dev/null and b/update-imported-docs/update-imported-docs-linux differ diff --git a/update-imported-docs/update-imported-docs b/update-imported-docs/update-imported-docs-macos similarity index 100% rename from update-imported-docs/update-imported-docs rename to update-imported-docs/update-imported-docs-macos